Skip to content

Commit 9600dbf

Browse files
Update README installation instructions, add PyPI badge / docs link (#30)
1 parent 9b2f1ec commit 9600dbf

File tree

1 file changed

+18
-15
lines changed

1 file changed

+18
-15
lines changed

README.md

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
11
# TileDB-SOMA-ML
2-
32
A Python package containing ML tools for use with [TileDB-SOMA].
43

4+
[![tiledbsoma-ml package on PyPI](https://img.shields.io/pypi/v/tiledbsoma-ml?label=tiledbsoma-ml)][pypi]
5+
6+
7+
Docs: [single-cell-data.github.io/TileDB-SOMA-ML].
8+
59
**NOTE:** this is a _pre-release_ package, and may be subject to breaking API changes prior to first release.
610

711
## Description
812

9-
The package contains a prototype PyTorch [`IterableDataset`] for use with the
10-
[`torch.utils.data.DataLoader`]
11-
API. For a general introduction to PyTorch data loading,
12-
[see this tutorial][torch data tutorial].
13-
Additional information on the DataLoader/Dataset pattern
14-
[can be found here][`torch.data`].
13+
The package contains a prototype PyTorch [`IterableDataset`], [`ExperimentDataset`], for use with the [`torch.utils.data.DataLoader`] API.
1514

16-
Defects and feature requests should be filed as a GitHub issue in this repo. Please include a reproducible test case in all bug reports.
15+
[notebooks/](notebooks) contains tutorials and examples that use this repo to train toy models. For a general introduction to PyTorch data loading, [see this tutorial][torch data tutorial]. Additional information on the DataLoader/Dataset pattern [can be found here][`torch.data`].
16+
17+
Defects and feature requests should be filed as [a GitHub issue][/issues] in this repo. Please include a reproducible test case in all bug reports.
1718

1819
## Getting Started
1920

2021
### Installing
2122

22-
Prior to the first release, installation is most easily accomplished by installing directly from GitHub:
23-
23+
Install [from PyPI][pypi]:
2424
```bash
25-
pip install git+https://github.com/single-cell-data/TileDB-SOMA-ML
25+
pip install tiledbsoma-ml
2626
```
2727

2828
Developers may install editable, from source, in the usual manner -- clone the repo and execute:
@@ -33,8 +33,7 @@ pip install -e .
3333

3434
### Documentation
3535

36-
Documentation is pending. Preliminary documentation can be found at [single-cell-data.github.io/TileDB-SOMA-ML], and in
37-
the [notebooks] directory.
36+
Documentation can be found at [single-cell-data.github.io/TileDB-SOMA-ML], and in the [notebooks] directory.
3837

3938
## Builds
4039

@@ -54,14 +53,18 @@ This project is licensed under the MIT License.
5453

5554
## Acknowledgements
5655

57-
The SOMA team is grateful to the Chan Zuckerberg Initiative Foundation [CELLxGENE Census](https://cellxgene.cziscience.com)
58-
team for their initial contribution.
56+
The SOMA team is grateful to the Chan Zuckerberg Initiative Foundation [CELLxGENE Census](https://cellxgene.cziscience.com) team for their initial contribution.
5957

6058
[TileDB-SOMA]: https://github.com/single-cell-data/TileDB-SOMA
6159
[`IterableDataset`]: https://pytorch.org/docs/stable/data.html#torch.utils.data.IterableDataset
60+
[`ExperimentDataset`]: src/tiledbsoma_ml/dataset.py
6261
[`torch.utils.data.DataLoader`]: https://pytorch.org/docs/stable/data.html#torch.utils.data.DataLoader
62+
[/issues]: https://github.com/single-cell-data/TileDB-SOMA-ML/issues/new
63+
[pypi]: https://pypi.org/project/tiledbsoma-ml/
6364
[torch data tutorial]: https://pytorch.org/tutorials/beginner/data_loading_tutorial.html
6465
[`torch.data`]: https://pytorch.org/docs/stable/data.html
6566
[single-cell-data.github.io/TileDB-SOMA-ML]: https://single-cell-data.github.io/TileDB-SOMA-ML/
6667
[notebooks]: notebooks
6768
[CHANGELOG.md]: CHANGELOG.md
69+
[www]: https://single-cell-data.github.io/TileDB-SOMA-ML/
70+
[single-cell-data.github.io/TileDB-SOMA-ML]: https://single-cell-data.github.io/TileDB-SOMA-ML/

0 commit comments

Comments
 (0)