small errata (#17)

* README errata

* autoupdate the pre-commit deps

* update CHANGELOG

* PR review feedback

.pre-commit-config.yaml

@@ -1,18 +1,18 @@
 repos:
   - repo: https://github.com/psf/black
-    rev: "24.8.0"
+    rev: "24.10.0"
     hooks:
       - id: black
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.6.5
+    rev: v0.6.9
     hooks:
       - id: ruff
         name: "ruff for tiledbsoma_ml"
         args: ["--config=pyproject.toml"]
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.11.2
+    rev: v1.12.0
     hooks:
       - id: mypy
         pass_filenames: false

CHANGELOG.md

@@ -8,11 +8,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased] - yyyy-mm-dd
 
-Port and enhance contribution from the Chan Zuckerberg Initiative Foundation
+Initial release of a PyTorch Dataset for SOMA Experiments. This is a port and
+enhancement of code contributed by 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), improved API UX, etc.
+been made to the package utility (e.g., multi-GPU support), improved API UX, performance
+improvements, and more.
 
 ### Added
 

README.md

@@ -3,33 +3,48 @@
 
 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 currently contains a prototype PyTorch `IterableDataset` for use with the
+The package 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.
+API. For a general introduction to PyTorch data loading,
+[see this tutorial](https://pytorch.org/tutorials/beginner/data_loading_tutorial.html).
+Additional information on the DataLoader/Dataset pattern
+[can be found here](https://pytorch.org/docs/stable/data.html).
+
+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
 
-Install using your favorite package installer.  For example, with pip:
+Prior to the first release, installation is most easily accomplished by installing directly from GitHub:
 
-> pip install tiledbsoma-ml
+```bash
+pip install git+https://github.com/single-cell-data/TileDB-SOMA-ML
+```
 
-Developers may install editable, from source, in the usual manner:
+Developers may install editable, from source, in the usual manner -- clone the repo and execute:
 
-> pip install -e .
+```bash
+pip install -e .
+```
 
 ### Documentation
 
-TBD
+Documentation is pending. Preliminary documentation can be found in API docstrings, and in
+the [notebooks](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 .
+```bash
+python -m build .
+```
 
 ## Version History