Skip to content

Commit b9c3fb8

Browse files
committed
feat: add starter notebook
1 parent 92d3abf commit b9c3fb8

File tree

3 files changed

+4664
-8
lines changed

3 files changed

+4664
-8
lines changed

README.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,22 @@
1-
# De novo peptide sequencing with InstaNovo
1+
# _De novo_ peptide sequencing with InstaNovo
22

3-
The official code repository for InstaNovo. This repo contains the code for training and inference
4-
of InstaNovo and InstaNovo+.
3+
[![PyPI version](https://badge.fury.io/py/instanovo.svg)](https://badge.fury.io/py/instanovo)
4+
<a target="_blank" href="https://colab.research.google.com/github/https://colab.research.google.com/github/instadeepai/InstaNovo/blob/main/notebooks/getting_started_with_instanovo.ipynb">
5+
<img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
6+
</a>
57

6-
Links:
7-
8-
- bioRxiv: https://www.biorxiv.org/content/10.1101/2023.08.30.555055v1
8+
The official code repository for InstaNovo. This repo contains the code for training and inference of InstaNovo and InstaNovo+. InstaNovo is a transformer neural network with the ability to translate fragment ion peaks into the sequence of amino acids that make up the studied peptide(s). InstaNovo+, inspired by human intuition, is a multinomial diffusion model that further improves performance by iterative refinement of predicted sequences.
99

1010
![Graphical Abstract](https://raw.githubusercontent.com/instadeepai/InstaNovo/main/graphical_abstract.jpeg)
1111

12-
Developed by: [InstaDeep](https://www.instadeep.com/) and the [Department of Biotechnology and Biomedicine](https://orbit.dtu.dk/en/organisations/department-of-biotechnology-and-biomedicine) - [Technical University
12+
13+
**Links:**
14+
15+
- bioRxiv: https://www.biorxiv.org/content/10.1101/2023.08.30.555055v1
16+
17+
**Developed by:**
18+
- [InstaDeep](https://www.instadeep.com/)
19+
- [The Department of Biotechnology and Biomedicine](https://orbit.dtu.dk/en/organisations/department-of-biotechnology-and-biomedicine) - [Technical University
1320
of Denmark](https://www.dtu.dk/)
1421

1522
## Usage
@@ -22,6 +29,13 @@ To use InstaNovo, we need to install the module via `pip`:
2229
pip install instanovo
2330
```
2431

32+
It is recommended to install InstaNovo in a fresh environment, such as Conda or PyEnv. For example, if you have [anaconda](https://www.anaconda.com/)/[miniconda](https://docs.conda.io/projects/miniconda/en/latest/) installed:
33+
34+
```bash
35+
conda create -n instanovo python=3.8
36+
conda activate instanovo
37+
```
38+
2539
Note: InstaNovo is built for Python >= 3.8
2640

2741
### Training

0 commit comments

Comments
 (0)