Skip to content

Commit

Permalink
improved readme
Browse files Browse the repository at this point in the history
  • Loading branch information
maxiallard committed May 31, 2024
1 parent 7c2a1c6 commit e1fd342
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 6 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,12 @@ git clone https://github.com/helicalAI/helical.git
Within the `example` folder, open the notebook of your choice. We recommend starting with `Quick-Start_Tutorial.ipynb`

### Current Examples:
- `Quick-Start_Tutorial.ipynb`: A tutorial to quickly get used to the helical package and environment. Try it out on Colab: [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/helicalAI/helical/blob/main/examples/Quick-Start_Tutorial.ipynb)
- `Geneformer-vs-UCE.ipynb`: Zero-Shot Reference Mapping with Geneformer & UCE and compare the outcomes. Try it out on Colab: [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/helicalAI/helical/blob/main/examples/Geneformer-vs-UCE.ipynb)
- Coming soon: new models such as scGPT, SCimilarity, scVI; benchmarking scripts; new use cases; others

| Example | Description | Colab |
| ----------- | ----------- |----------- |
|[Quick-Start_Tutorial.ipynb](./examples/Quick-Start_Tutorial.ipynb)| A tutorial to quickly get used to the helical package and environment. | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/helicalAI/helical/blob/main/examples/Quick-Start_Tutorial.ipynb)|
|[Geneformer-vs-UCE.ipynb](./examples/Geneformer-vs-UCE.ipynb) | Zero-Shot Reference Mapping with Geneformer & UCE and compare the outcomes. | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/helicalAI/helical/blob/main/examples/Geneformer-vs-UCE.ipynb) |
| Coming Soon | New models such as scGPT, SCimilarity, scVI; benchmarking scripts; new use cases; others |

## Stuck somewhere ? Other ideas ?
We are eager to help you and interact with you. Reach out via [email protected].
Expand Down
9 changes: 6 additions & 3 deletions docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,12 @@ git clone https://github.com/helicalAI/helical.git
Within the `example` folder, open the notebook of your choice. We recommend starting with `Quick-Start_Tutorial.ipynb`

### Current Examples:
- `Quick-Start_Tutorial.ipynb`: A tutorial to quickly get used to the helical package and enbironment. - [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/helicalAI/helical/blob/main/examples/Quick-Start_Tutorial.ipynb)
- `Geneformer-vs-UCE.ipynb`: Zero-Shot Reference Mapping with Geneformer & UCE and compare the outcomes. [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/helicalAI/helical/blob/main/examples/Geneformer-vs-UCE.ipynb)
- Coming soon: new models such as scGPT, SCimilarity, scVI; benchmarking scripts; new use cases; others

| Example | Description | Colab |
| ----------- | ----------- |----------- |
|[Quick-Start_Tutorial.ipynb](./examples/Quick-Start_Tutorial.ipynb)| A tutorial to quickly get used to the helical package and environment. | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/helicalAI/helical/blob/main/examples/Quick-Start_Tutorial.ipynb)|
|[Geneformer-vs-UCE.ipynb](./examples/Geneformer-vs-UCE.ipynb) | Zero-Shot Reference Mapping with Geneformer & UCE and compare the outcomes. | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/helicalAI/helical/blob/main/examples/Geneformer-vs-UCE.ipynb) |
| Coming Soon | New models such as scGPT, SCimilarity, scVI; benchmarking scripts; new use cases; others |

## Stuck somewhere ? Other ideas ?
We are eager to help you and interact with you. Reach out via [email protected].
Expand Down

0 comments on commit e1fd342

Please sign in to comment.