Skip to content

Commit

Permalink
Add Colab icon
Browse files Browse the repository at this point in the history
  • Loading branch information
xiachenrui committed Oct 26, 2024
1 parent 09292d2 commit a004062
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 5 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,12 @@
![DECIPHER](./docs/_static/Model.png)

## Installation

### PyPI

> [!IMPORTANT]
> Requires Python >= 3.10 and CUDA-enabled GPU (CPU-only device is not recommended).
### PyPI
We recommend to install `cell-decipher` to a new conda environment with [RAPIDS](https://docs.rapids.ai/install) dependencies.

```sh
Expand All @@ -30,13 +32,15 @@ install_pyg_dependencies
```

### Docker
Build docker image from [Dockerfile](./Dockerfile) or pull the latest image from Docker Hub by:

Build docker image from [Dockerfile](./Dockerfile) or pull image from Docker Hub directly:

```sh
docker pull huhansan666666/decipher:latest
docker run --gpus all -it --rm huhansan666666/decipher:latest
```

## Documentation
> Please check [**documentation**](https://slat.readthedocs.io/en/latest/) for detailed tutorial.

### Minimal example
Here is a minimal example for quick start:
Expand All @@ -61,10 +65,11 @@ spatial_emb = model.nbr_emb
```

### Demo
> Please check [**documentation**](https://slat.readthedocs.io/en/latest/) for detailed tutorial.
| Name | Description |
| --------------------------------------- | ------------------------------------------------------------ |
| [Basic Model Tutorial]() ([Colab](https://colab.research.google.com/drive/14PEtrgqlf-KbLOTfBLc9gbx0YvY6mi0S?usp=sharing)) | Tutorial on how to train DECIPHER |
| [Basic Model Tutorial]() ([![Open In Colab](https://img.shields.io/badge/Colab-PyTorch-blue?logo=googlecolab)](https://colab.research.google.com/drive/14PEtrgqlf-KbLOTfBLc9gbx0YvY6mi0S?usp=sharing)) | Tutorial on how to train DECIPHER |
| [Identify Localization Related Genes]() | Tutorial on how to identify cells’ localization related genes via DECIPHER embeddings|
| [Multi-slices with Batch Effects]() | Tutorial on how to remove batch effects across multiple slices |
| [DDP Training]() | Tutorial on how to use multi-GPUs on large datasets |
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/train_model.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
},
{
"cell_type": "code",
"execution_count": 15,
"execution_count": 26,
"metadata": {},
"outputs": [],
"source": [
Expand Down

0 comments on commit a004062

Please sign in to comment.