Skip to content

Commit

Permalink
Fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
xiachenrui committed Nov 14, 2024
1 parent 11f00b6 commit 669ef5e
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 7 deletions.
9 changes: 3 additions & 6 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,14 @@ version: 2
build:
os: ubuntu-20.04
tools:
python: "3.8"
python: "3.11"
apt_packages:
- pandoc
jobs:
post_create_environment:
- pip install torch==1.11.0+cpu --extra-index-url https://download.pytorch.org/whl/cpu
- pip install https://data.pyg.org/whl/torch-1.11.0%2Bcpu/torch_cluster-1.6.0-cp38-cp38-linux_x86_64.whl
- pip install https://data.pyg.org/whl/torch-1.11.0%2Bcpu/torch_scatter-2.0.9-cp38-cp38-linux_x86_64.whl
- pip install https://data.pyg.org/whl/torch-1.11.0%2Bcpu/torch_sparse-0.6.15-cp38-cp38-linux_x86_64.whl
- pip install torch-geometric
- pip install torch==2.0.0+cpu --extra-index-url https://download.pytorch.org/whl/cpu
- pip install cell-decipher
- pip --no-cache-dir install pyg_lib torch_scatter torch_sparse torch_cluster torch_spline_conv -f https://data.pyg.org/whl/torch-2.0.0+cpu.html
sphinx:
configuration: docs/conf.py
python:
Expand Down
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,11 +84,13 @@ sc.pl.umap(adata, color=['region'])


## Citation
In preparation.
In coming.

> If you want to repeat our benchmarks and case studies, please check the [**benchmark**](./benchmark/README.md) and [**experiments**](./experiments/README.md) folder.
## FAQ
> Please open a new [github issue](https://github.com/gao-lab/DECIPHER/issues/new/choose) if you meeting problem.
1. `CUDA out of memory` error

The `model.train_gene_select()` function in [Identify Localization-related LRs](./docs/tutorials/3-select_LRs.ipynb) tutorial (~700k cells and 1k LRs) uses ~40G GPU memory. If your GPU do not have enough memory, you still can train model on GPU but disabling GPU in `train_gene_select()` function.
Expand Down

0 comments on commit 669ef5e

Please sign in to comment.