Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make some Experiment/Query classes abstract #244

Merged
merged 4 commits into from
Nov 18, 2024
Merged

Make some Experiment/Query classes abstract #244

merged 4 commits into from
Nov 18, 2024

Conversation

ryan-williams
Copy link
Member

@ryan-williams ryan-williams commented Nov 7, 2024

Move several classes/files to TileDB-SOMA (single-cell-data/TileDB-SOMA#3307), leave abstract interfaces here.

@ryan-williams ryan-williams force-pushed the rw/abcs branch 2 times, most recently from 85a895d to e605b6f Compare November 7, 2024 20:14
@ryan-williams ryan-williams changed the title Make some {experiment,query}.py classes abstract Make some Experiment/Query classes abstract Nov 7, 2024
@ryan-williams ryan-williams force-pushed the rw/abcs branch 2 times, most recently from 79cb3c2 to 884e8a4 Compare November 8, 2024 13:47
@ryan-williams ryan-williams marked this pull request as ready for review November 8, 2024 13:53
Copy link
Member

@johnkerl johnkerl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@ryan-williams
Copy link
Member Author

I pushed one more commit, explicitly tagging ExperimentAxisQuery/AxisIndexer as ABCs.

@jp-dark had suggested using Protocols last week; I'm not clear on what the advantages might be of that.

@johnkerl
Copy link
Member

@jp-dark had suggested using Protocols last week; I'm not clear on what the advantages might be of that.

@ryan-williams I think the suggestion has merit but I'd prefer to take it as follow-on work and not let it block this current PR.

@ryan-williams ryan-williams merged commit 99b22f9 into main Nov 18, 2024
6 checks passed
@ryan-williams ryan-williams deleted the rw/abcs branch November 18, 2024 17:41
ryan-williams added a commit to single-cell-data/TileDB-SOMA-ML that referenced this pull request Jan 27, 2025
`EagerIterator` was moved from `somacore` to `tiledbsoma` in single-cell-data/SOMA#244 / single-cell-data/TileDB-SOMA#3307 (released 1.0.24 / 1.15.0). THis `import` shim helps us support versions before and since those.
ryan-williams added a commit to single-cell-data/TileDB-SOMA-ML that referenced this pull request Feb 11, 2025
…www` builds (#26)

* Rename `{EAQ,Batch}Iterable`

* Add `EagerIterator` shim

`EagerIterator` was moved from `somacore` to `tiledbsoma` in single-cell-data/SOMA#244 / single-cell-data/TileDB-SOMA#3307 (released 1.0.24 / 1.15.0). THis `import` shim helps us support versions before and since those.

* More descriptive test var names

* rm `IterDataPipe`

* Rename: `Experiment{AxisQueryIterable,}Dataset`

* Move batch-"squeeze" logic down to `BatchIterable`

This makes `ExperimentDataset` a pure pass-through wrapper around `BatchIterable`, in preparation for folding the latter intothe former.

* Fold `BatchIterable` into `ExperimentDataset`

* Rename kwarg: `{X,layer}_name`

* Require `io_batch_size % shuffle_chunk_size == 0`

* More consistent kwarg ordering

* `parametrize("use_eager_fetch")`

* `tests._utils.parametrize`

* Add space to `# type: ignore`s

* Add `docs/`: Sphinx/RTD build

* Add `www/`: shuffling simulation

- Vite app, builds under `www/dist/shuffle/`
- `make dist` (under `docs/`) builds Sphix/RTD site (`make html`), copies it to `www/dist/`, and builds Vite app
- `ghp.yml` GHA uploads combined build to GHP

* Update README, CHANGELOG

* cr: notebook copy tweak

https://github.com/single-cell-data/TileDB-SOMA-ML/pull/26/files#r1936198406

* cr: add private note to `_csr` docstr

https://github.com/single-cell-data/TileDB-SOMA-ML/pull/26/files#r1934615892

* cr: rm `CSR_IO_Buffer` ivar decls

https://github.com/single-cell-data/TileDB-SOMA-ML/pull/26/files#r1934599631

* cr: docstr nit

https://github.com/single-cell-data/TileDB-SOMA-ML/pull/26/files#r1934663531

* cr: rename "GPU batches" to "mini batches"

https://github.com/single-cell-data/TileDB-SOMA-ML/pull/26/files#r1934665025

* cr: mention `layer_name` kwarg rename in CHANGELOG

https://github.com/single-cell-data/TileDB-SOMA-ML/pull/26/files#r1934668910

* cr: docstr nit

https://github.com/single-cell-data/TileDB-SOMA-ML/pull/26/files#r1934686963

* cr: update CHANGELOG

https://github.com/single-cell-data/TileDB-SOMA-ML/pull/26/files#r1943429030

* cr: export `.common` types in `tiledbsoma_ml/__init__.py`

https://github.com/single-cell-data/TileDB-SOMA-ML/pull/26/files#r1943430810

* cr: vendor `tiledbsoma._eager_iter`

https://github.com/single-cell-data/TileDB-SOMA-ML/pull/26/files#r1943421917
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants