Skip to content

Commit

Permalink
chore: fix docs generation
Browse files Browse the repository at this point in the history
  • Loading branch information
elkoz committed Dec 21, 2023
1 parent a638194 commit 1ddba89
Show file tree
Hide file tree
Showing 7 changed files with 818 additions and 125 deletions.
186 changes: 142 additions & 44 deletions docs/data/index.html

Large diffs are not rendered by default.

312 changes: 236 additions & 76 deletions docs/data/torch.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ <h2 id="installation">Installation</h2>
<pre><code class="language-bash">docker pull adaptyvbio/proteinflow
</code></pre>
<p>By default installing <code><a title="proteinflow" href="#proteinflow">proteinflow</a></code> with conda or pip will only load the dependencies that are required for the main functions of the package: downloading, generating and splitting datasets. If you are interested in using other functions like visualization, metrics and other data processing methods, please install the package with <code>pip install <a title="proteinflow" href="#proteinflow">proteinflow</a>[<a title="proteinflow.processing" href="processing/index.html">proteinflow.processing</a>]</code> or use the docker image.</p>
<p>Some metric functions also have separate requirements, see the documentation for details.</p>
<p>Some metric functions also have separate requirements, see the documentation for details. All of them are installed in the docker image.</p>
<h3 id="troubleshooting">Troubleshooting</h3>
<ul>
<li>If you are using python 3.10 and encountering installation problems, try running <code>python -m pip install prody==2.4.0</code> before installing <code><a title="proteinflow" href="#proteinflow">proteinflow</a></code>.</li>
Expand Down Expand Up @@ -269,7 +269,7 @@ <h2 id="proteinflow-stable-releases">ProteinFlow Stable Releases</h2>

By default installing `proteinflow` with conda or pip will only load the dependencies that are required for the main functions of the package: downloading, generating and splitting datasets. If you are interested in using other functions like visualization, metrics and other data processing methods, please install the package with `pip install proteinflow[processing]` or use the docker image.

Some metric functions also have separate requirements, see the documentation for details.
Some metric functions also have separate requirements, see the documentation for details. All of them are installed in the docker image.

### Troubleshooting
- If you are using python 3.10 and encountering installation problems, try running `python -m pip install prody==2.4.0` before installing `proteinflow`.
Expand Down
Loading

0 comments on commit 1ddba89

Please sign in to comment.