Skip to content

Update readme #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
falexwolf wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update readme #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 5 additions & 8 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
Intercode - Interpretable Autoencoder
======================================
=====================================

Intercode is a package to learn interpretable latent representation of single-cell data.
Intercode contains the implementation of the autoencoder which forces latent dimensions
to correspond to predefined gene sets.
Intercode learns interpretable representations of scRNA-seq by regularizing a latent autoencoder space with knowledge encoded in gene sets.

Usage and installation
--------------------------------------
----------------------
Intercode requires pytorch, numpy and anndata.

Install with pip
Expand All @@ -15,6 +13,5 @@ Install with pip

pip install intercode

See `the notebooks <https://github.com/theislab/intercode/tree/main/notebooks>`_ for the examples.

Read `the preprint <https://www.biorxiv.org/content/10.1101/2020.12.02.401182v1>`_ for description.
* See `the tutorials <https://github.com/theislab/intercode-tutorials>`__ for the examples.
* Read `the preprint <https://www.biorxiv.org/content/10.1101/2020.12.02.401182v1>`__.