From a00406233e5f66655500fb53bc0ebb609e18d238 Mon Sep 17 00:00:00 2001 From: xiachenrui Date: Sat, 26 Oct 2024 17:47:18 +0800 Subject: [PATCH] Add Colab icon --- README.md | 13 +++++++++---- docs/tutorials/train_model.ipynb | 2 +- 2 files changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ad12683..1246156 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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: @@ -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 | diff --git a/docs/tutorials/train_model.ipynb b/docs/tutorials/train_model.ipynb index 835305b..eb4d323 100644 --- a/docs/tutorials/train_model.ipynb +++ b/docs/tutorials/train_model.ipynb @@ -20,7 +20,7 @@ }, { "cell_type": "code", - "execution_count": 15, + "execution_count": 26, "metadata": {}, "outputs": [], "source": [