Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the OS, Python version, and other tools you might need
build:
os: ubuntu-20.04
tools:
python: "3.8"

# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/conf.py

# Optionally, but recommended,
# declare the Python requirements required to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
install:
- requirements: docs/requirements.txt

2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2025 Min Li's Lab
Copyright (c) 2025 scLinguist team

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,7 @@ python setup.py install
* [`zeroshot`](./integration_examples/vertical)
* [`fewshot`](./integration_examples/mosaic)
* [`imputation `](./imputation_examples/) -->
TODO
We provided detailed tutorials on applying scLinguist to various tasks. Please refer to [https://scLinguist.readthedocs.io/en/latest/](https://scLinguist.readthedocs.io/en/latest/).
We provided detailed tutorials on applying scLinguist to various tasks. Please refer to [https://scLinguist.readthedocs.io/en/latest/](https://sclinguist.readthedocs.io/en/stable/).

## Pre-trained model
The pre-trained models can be downloaded from these links.
Expand Down
11 changes: 11 additions & 0 deletions data/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Data used for scLinguist
| File | Google Drive Link |
|------|-----------------|
| ./fewshot_sample_adt.h5ad | [Link](https://drive.google.com/file/d/1iCL8iwZZ2nDZUb9D6L7LWxtZLP4Jbc7o/view?usp=sharing) |
| ./fewshot_sample_rna.h5ad | [Link](https://drive.google.com/file/d/1P87XOylSWrTE1wqagnV7f4Kjb1p04u_i/view?usp=sharing) |
| ./test_sample_adt.h5ad | [Link](https://drive.google.com/file/d/18dGKWfLz3vYVS03NcvBQn5mR7oLheXBx/view?usp=sharing) |
| ./test_sample_rna.h5ad | [Link](https://drive.google.com/file/d/1-AhLZpp6KrKafjs-I1LXwpkzck8O5Fku/view?usp=sharing) |
| ./train_sample_adt.h5ad | [Link](https://drive.google.com/file/d/1tKuy0ET9zhA_vrkJ04DSVi7lnNUM7Su8/view?usp=sharing) |
| ./train_sample_rna.h5ad | [Link](https://drive.google.com/file/d/1uVI76zJOLVE0id9j9YAylu11EN35x8UJ/view?usp=sharing) |
| ./valid_sample_adt.h5ad | [Link](https://drive.google.com/file/d/1tDCgioIGaFJgzzenlR0_iRHjkdfhy75J/view?usp=sharing) |
| ./valid_sample_rna.h5ad | [Link](https://drive.google.com/file/d/1PufrFTcEijCZXWF-4BgJhKcLJBib-LG4/view?usp=sharing) |
20 changes: 20 additions & 0 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
BUILDDIR = _build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
Binary file added docs/_build/doctrees/credits.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/datasets.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/environment.pickle
Binary file not shown.
Binary file added docs/_build/doctrees/index.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/install.doctree
Binary file not shown.
Loading