Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nsheff committed Feb 20, 2024
1 parent 2a2d736 commit c162741
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 9 deletions.
4 changes: 4 additions & 0 deletions docs/geniml/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html) and [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format.

## [0.2.0] -- 2024-02-20

- Fixed a bug with pydantic

## [0.1.0] -- 2023-12-18

- First official released version of geniml
Expand Down
20 changes: 11 additions & 9 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -82,24 +82,26 @@ nav:
- Getting Started:
- Module overviews: geniml/modules.md
- How-to guides:
- Train region2vec embeddings: geniml/tutorials/region2vec.md
- Train single-cell embeddings: geniml/tutorials/train-scembed-model.md
- Cache BED files with BBClient: geniml/tutorials/bbclient.md
- Tokenization: geniml/tutorials/tokenization.md
- Tokenize a BED file on the command line: geniml/tutorials/cli-tokenization.md
- Tokenize a BED file with CLI: geniml/tutorials/cli-tokenization.md
- Train region2vec embeddings: geniml/tutorials/region2vec.md
- Train BEDspace model:
- Train BEDSpace embeddings: geniml/tutorials/bedspace.md
- BEDspace results notebook: geniml/code/bedspace-analysis.md
- Use scEmbed model:
- Train single-cell embeddings: geniml/tutorials/train-scembed-model.md
- Populate a vector store: geniml/tutorials/load-qdrant-with-cell-embeddings.md
- Predict cell-types using KNN: geniml/tutorials/cell-type-annotation-with-knn.md
- Evaluate embeddings: geniml/tutorials/evaluation.md
- Search intervals with BEDSpace: geniml/tutorials/bedspace.md
- Load vector database with embeddings: tutorials/load-qdrant-with-cell-embeddings.md
- Cell-type prediction using KNN: tutorials/cell-type-annotation-with-knn.md
- Create consensus peaks: geniml/tutorials/create-consensus-peaks.md
- Assess universe fit: geniml/tutorials/assess-universe.md
- Fine-tune embeddings: geniml/tutorials/fine-tune-region2vec-model.md
- Randomize bed files: geniml/tutorials/bedshift.md
- Create evaluation dataset with bedshift: geniml/tutorials/bedshift-evaluation-guide.md
- Tutorials:
- Using BEDspace: geniml/code/bedspace-analysis.md
- Reference:
- How to cite: citations.md
- API: geniml/autodoc_build/geniml.md
- API documentation: geniml/autodoc_build/geniml.md
- Support: geniml/support.md
- Contributing: geniml/contributing.md
- Changelog: geniml/changelog.md
Expand Down

0 comments on commit c162741

Please sign in to comment.