Diff of /README.md [000000] .. [5ad33c]

Switch to unified view

a b/README.md
1
# scVAE: Single-cell variational auto-encoders #
2
3
scVAE is a command-line tool for modelling single-cell transcript counts using variational auto-encoders.
4
5
Install scVAE using pip for Python 3.6 and 3.7:
6
7
    $ python3 -m pip install scvae
8
9
scVAE can then be used to train a variational auto-encoder on a data set of single-cell transcript counts:
10
11
    $ scvae train transcript_counts.tsv
12
13
And the resulting model can be evaluated on the same data set:
14
15
    $ scvae evaluate transcript_counts.tsv
16
17
For more details, see the [documentation][], which include a user guide and a short tutorial.
18
19
[documentation]: https://scvae.readthedocs.io