Skip to content

Commit 0590933

Browse files
use public links in README
1 parent 784353d commit 0590933

File tree

3 files changed

+27
-5
lines changed

3 files changed

+27
-5
lines changed

README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
<p align="center">
2-
<img src="docs/assets/banner.png" alt="novae_banner" width="100%"/>
2+
<img src="https://raw.githubusercontent.com/MICS-Lab/novae/main/docs/assets/banner.png" alt="novae_banner" width="100%"/>
33
</p>
4-
<!-- TODO: when it becomes public: https://raw.githubusercontent.com/MICS-Lab/novae/main/docs/assets/banner.png -->
54

65
<div align="center">
76

@@ -20,14 +19,16 @@
2019
💫 Graph-based foundation model for spatial transcriptomics data
2120
</b></i></p>
2221

22+
Novae is a deep learning model for spatial domain assignments of spatial transcriptomics data (at both single-cell or spot resolution). It works across multiple gene panels, tissues, and technologies. Novae offers several additional features, including: (i) native batch-effect correction, (ii) analysis of spatially variable genes and pathways, and (iii) architecture analysis of tissue slides.
23+
2324
## Documentation
2425

2526
Check [Novae's documentation](https://mics-lab.github.io/novae/) to get started. It contains installation explanations, API details, and tutorials.
2627

2728
## Overview
2829

2930
<p align="center">
30-
<img src="docs/assets/Figure1.png" alt="novae_overview" width="100%"/>
31+
<img src="https://raw.githubusercontent.com/MICS-Lab/novae/main/docs/assets/Figure1.png" alt="novae_overview" width="100%"/>
3132
</p>
3233

3334
> **(a)** Novae was trained on a large dataset, and is shared on [Hugging Face Hub](https://huggingface.co/collections/MICS-Lab/novae-669cdf1754729d168a69f6bd). **(b)** Illustration of the main tasks and properties of Novae. **(c)** Illustration of the method behing Novae (self-supervision on graphs, adapted from [SwAV](https://arxiv.org/abs/2006.09882)).

docs/index.md

+22-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,25 @@
22
<img src="./assets/logo_white.png" alt="novae_logo" width="300px"/>
33
</p>
44

5-
TODO
5+
<p align="center"><b><i>
6+
💫 Graph-based foundation model for spatial transcriptomics data
7+
</b></i></p>
8+
9+
Novae is a deep learning model for spatial domain assignments of spatial transcriptomics data (at both single-cell or spot resolution). It works across multiple gene panels, tissues, and technologies. Novae offers several additional features, including: (i) native batch-effect correction, (ii) analysis of spatially variable genes and pathways, and (iii) architecture analysis of tissue slides.
10+
11+
## Overview
12+
13+
<p align="center">
14+
<img src="https://raw.githubusercontent.com/MICS-Lab/novae/main/docs/assets/Figure1.png" alt="novae_overview" width="100%"/>
15+
</p>
16+
17+
> **(a)** Novae was trained on a large dataset, and is shared on [Hugging Face Hub](https://huggingface.co/collections/MICS-Lab/novae-669cdf1754729d168a69f6bd). **(b)** Illustration of the main tasks and properties of Novae. **(c)** Illustration of the method behing Novae (self-supervision on graphs, adapted from [SwAV](https://arxiv.org/abs/2006.09882)).
18+
19+
20+
## Why using Novae
21+
22+
- It is already pretrained on a large dataset (pan human/mouse tissues, brain, ...). Therefore, you can compute spatial domains in a zero-shot manner (i.e., without fine-tuning).
23+
- It has been developed to find consistent domain across many slides. This also work if you have different technologies (e.g., MERSCOPE/Xenium) and multiple gene panels.
24+
- You can natively correct batch effect, without using external tools.
25+
- After inference, the spatial domain assignment is super fast, allowing to try multiple resolutions easily.
26+
- It supports many downstream tasks, all included inside one framework.

pyproject.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "novae"
3-
version = "0.0.2"
3+
version = "0.0.5"
44
description = "Graph-based foundation model for spatial transcriptomics data"
55
documentation = "https://mics-lab.github.io/novae/"
66
homepage = "https://mics-lab.github.io/novae/"

0 commit comments

Comments
 (0)