tiledbsoma_ml

A Python package containing ML tools for use with tiledbsoma.

NOTE: this is a pre-release package, and may be subject to breaking API changes prior to first release.

Description

The package contains a prototype PyTorch IterableDataset for use with the torch.utils.data.DataLoader API. For a general introduction to PyTorch data loading, see this tutorial. Additional information on the DataLoader/Dataset pattern can be found here.

Defects and feature requests should be filed as a GitHub issue in this repo. Please include a reproducible test case in all bug reports.

Getting Started

Installing

Prior to the first release, installation is most easily accomplished by installing directly from GitHub:

pip install git+https://github.com/single-cell-data/TileDB-SOMA-ML

Developers may install editable, from source, in the usual manner -- clone the repo and execute:

pip install -e .

Documentation

Documentation is pending. Preliminary documentation can be found in API docstrings, and in the notebooks directory.

Builds

This is a pure Python package. To build a wheel, ensure you have the build package installed, and then:

python -m build .

Version History

See the CHANGELOG.md file.

License

This project is licensed under the MIT License.

Acknowledgements

The SOMA team is grateful to the Chan Zuckerberg Initiative Foundation CELLxGENE Census team for their initial contribution.