Skip to content

Commit

Permalink
fixed docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Avsecz committed Nov 30, 2016
1 parent 862aa88 commit a95e43c
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 10 deletions.
1 change: 1 addition & 0 deletions AUTHORS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ Contributors

* Prof. Dr. Julien Gagneur <gagneur@in.tum.de>
* Gagneur lab http://www.gagneurlab.in.tum.de

1 change: 1 addition & 0 deletions HISTORY.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,4 @@ History
------------------

* Added L-BFGS optimizer in addition to Adam. Use optimizer="lbfgs" in Concise()

18 changes: 8 additions & 10 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,28 +13,24 @@ CONCISE
:target: https://concise-bio.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

..
.. image:: https://pyup.io/repos/github/avsecz/concise/shield.svg
:target: https://pyup.io/repos/github/avsecz/concise/
:alt: Updates

CONCISE (COnvolutional neural Network for CIS-regulatory Elements) is a model for predicting any quatitative outcome (say mRNA half-life) from cis-regulatory sequence using deep learning.

* Developed by the Gagneur Lab (computational biology): http://www.gagneurlab.in.tum.de
* Free software: MIT license
* Documentation: https://concise-bio.readthedocs.io

.. image:: concise-figure1.png
:width: 60%
:align: center
.. image:: https://github.com/Avsecz/concise/blob/master/concise-figure1.png
:width: 60%
:align: center

Features
--------

* Very simple API
* Serializing the model to JSON
- allows to analyze the results in any langugage of choice

* allows to analyze the results in any langugage of choice

* Helper function for hyper-parameter random search
* CONCISE uses TensorFlow at its core and is hence able of using GPU computing

Expand All @@ -46,6 +42,7 @@ After installing the following prerequisites:
1. Python (3.4 or 3.5) with pip (see `Python installation guide`_ and `pip documentation`_)
2. TensorFlow python package (see `TensorFlow installation guide`_ or `Installing Tensorflow on AWS GPU-instance`_)


install CONCISE using pip:

::
Expand Down Expand Up @@ -129,3 +126,4 @@ Where to go from here:

* See the example file `<scripts/example-workflow.py>`_
* Read the API Documenation https://concise-bio.readthedocs.io/en/latest/documentation.html

0 comments on commit a95e43c

Please sign in to comment.