diff --git a/CHANGELOG.md b/CHANGELOG.md index 91b7fc3..1e69c79 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,10 +12,18 @@ Port and enhance contribution from the Chan Zuckerberg Initiative Foundation [CELLxGENE](https://cellxgene.cziscience.com/) project. This is not a one-for-one migration of the contributed code. Substantial changes have -been made to the package utility (e.g., multi-GPU support), improve API usability, etc. +been made to the package utility (e.g., multi-GPU support), improved API UX, etc. ### Added +- Initial project organization and other scaffolding [PR #4](https://github.com/single-cell-data/TileDB-SOMA-ML/pull/4) +- Simple, non-shuffling Dataset/DataPipe implementation [PR #6](https://github.com/single-cell-data/TileDB-SOMA-ML/pull/6) +- Add CI workflows [PR #7](https://github.com/single-cell-data/TileDB-SOMA-ML/pull/7) +- Add a DataLoader creation wrapper function [PR #8](https://github.com/single-cell-data/TileDB-SOMA-ML/pull/8) +- Add shuffling support [PR #9](https://github.com/single-cell-data/TileDB-SOMA-ML/pull/9) +- Add first draft of tutorial notebooks [PR #10](https://github.com/single-cell-data/TileDB-SOMA-ML/pull/10) +- Archive script used to populate the repo commit history [PR #11](https://github.com/single-cell-data/TileDB-SOMA-ML/pull/11) + ### Changed ### Fixed diff --git a/README.md b/README.md new file mode 100644 index 0000000..f513bc8 --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ + +# tiledbsoma_ml + +A Python package containing ML tools for use with `tiledbsoma`. + +## Description + +The package currently contains a prototype PyTorch `IterableDataset` for use with the +[`torch.utils.data.DataLoader`](https://pytorch.org/docs/stable/data.html#torch.utils.data.DataLoader) +API. + +## Getting Started + +### Installing + +Install using your favorite package installer. For example, with pip: + +> pip install tiledbsoma-ml + +Developers may install editable, from source, in the usual manner: + +> pip install -e . + +### Documentation + +TBD + +## 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](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](https://cellxgene.cziscience.com) +team for their initial contribution.