Skip to content

Commit

Permalink
docs updated
Browse files Browse the repository at this point in the history
  • Loading branch information
akabiraka committed May 8, 2024
1 parent 7d25d4d commit 8f190ed
Show file tree
Hide file tree
Showing 6 changed files with 103 additions and 24 deletions.
42 changes: 34 additions & 8 deletions docs/_sources/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This repository corresponds to the article titled **"Advancing Transcription Fac


.. figure:: ../../plots/EPBD_Arch.jpg
:width: 50%
:width: 70%
:align: center

Figure 1: Overview of the proposed EPBDxBERT framework.
Expand Down Expand Up @@ -38,6 +38,26 @@ Resources
* `Analysis Notebooks <https://github.com/lanl/EPBD-BERT/tree/main/analysis>`_


Installation
========================================
.. code-block:: shell
# Installation of virtural environment
git clone https://github.com/lanl/EPBD-BERT.git
cd EPBD-BERT
conda create -c conda-forge -p .venvs/epbd_bert_condavenv_test1 python=3.11 -y
conda activate .venvs/epbd_bert_condavenv_test1
python setup.py install
conda install -c conda-forge scikit-learn scipy -y
pip uninstall triton # We did not utilize triton for underlying hardware dependency
# To deactivate and remove the venv
conda deactivate
conda remove --name epbd_bert_condavenv_test1 --all -y
conda remove -p .venvs/epbd_bert_condavenv_test1 --all -y
Acknowledgements
========================================
Los Alamos National Lab (LANL), T-1
Expand Down Expand Up @@ -90,17 +110,23 @@ Authors
- `Anny Usheva <mailto:Anny\_[email protected]>`_: Surgery, Rhode Island Hospital and Brown University

How to cite EPBD-BERT?
==================
========================================

.. code-block:: console
@article{kabir2024advancing,
title = {Advancing Transcription Factor Binding Site Prediction Using DNA Breathing Dynamics and Sequence Transformers via Cross Attention},
author = {Kabir, Anowarul and Bhattarai, Manish and Rasmussen, Kim {\O} and Shehu, Amarda and Bishop, Alan R and Alexandrov, Boian and Usheva, Anny},
journal = {bioRxiv},
pages = {2024--01},
year = {2024},
publisher = {Cold Spring Harbor Laboratory}
title = {Advancing Transcription Factor Binding Site Prediction Using DNA Breathing Dynamics and Sequence Transformers via Cross Attention},
author = {Kabir, Anowarul and
Bhattarai, Manish and
Rasmussen, Kim {\O} and
Shehu, Amarda and
Bishop, Alan R and
Alexandrov, Boian and
Usheva, Anny},
journal = {bioRxiv},
pages = {2024--01},
year = {2024},
publisher= {Cold Spring Harbor Laboratory}
doi = {10.5281/zenodo.11130474},
url = {https://www.biorxiv.org/content/10.1101/2024.01.16.575935v2}
}
Expand Down
Binary file modified docs/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/doctrees/index.doctree
Binary file not shown.
41 changes: 34 additions & 7 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -313,6 +313,7 @@ <h2> Contents </h2>
<ul class="visible nav section-nav flex-column">
<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#">Welcome to EPBD-BERT’s documentation!</a></li>
<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#resources">Resources</a></li>
<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#installation">Installation</a></li>
<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#acknowledgements">Acknowledgements</a></li>
<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#copyright-notice">Copyright notice</a></li>
<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#license">License</a></li>
Expand All @@ -336,7 +337,7 @@ <h2> Contents </h2>
<h1>Welcome to EPBD-BERT’s documentation!<a class="headerlink" href="#welcome-to-epbd-bert-s-documentation" title="Link to this heading">#</a></h1>
<p>This repository corresponds to the article titled <strong>“Advancing Transcription Factor Binding Site Prediction Using DNA Breathing Dynamics and Sequence Transformers via Cross Attention”</strong>.</p>
<figure class="align-center" id="id2">
<a class="reference internal image-reference" href="_images/EPBD_Arch.jpg"><img alt="_images/EPBD_Arch.jpg" src="_images/EPBD_Arch.jpg" style="width: 50%;" /></a>
<a class="reference internal image-reference" href="_images/EPBD_Arch.jpg"><img alt="_images/EPBD_Arch.jpg" src="_images/EPBD_Arch.jpg" style="width: 70%;" /></a>
<figcaption>
<p><span class="caption-text">Figure 1: Overview of the proposed EPBDxBERT framework.</span><a class="headerlink" href="#id2" title="Link to this image">#</a></p>
</figcaption>
Expand Down Expand Up @@ -365,6 +366,25 @@ <h1>Resources<a class="headerlink" href="#resources" title="Link to this heading
<li><p><a class="reference external" href="https://github.com/lanl/EPBD-BERT/tree/main/analysis">Analysis Notebooks</a></p></li>
</ul>
</section>
<section id="installation">
<h1>Installation<a class="headerlink" href="#installation" title="Link to this heading">#</a></h1>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="c1"># Installation of virtural environment</span>
git<span class="w"> </span>clone<span class="w"> </span>https://github.com/lanl/EPBD-BERT.git
<span class="nb">cd</span><span class="w"> </span>EPBD-BERT
conda<span class="w"> </span>create<span class="w"> </span>-c<span class="w"> </span>conda-forge<span class="w"> </span>-p<span class="w"> </span>.venvs/epbd_bert_condavenv_test1<span class="w"> </span><span class="nv">python</span><span class="o">=</span><span class="m">3</span>.11<span class="w"> </span>-y
conda<span class="w"> </span>activate<span class="w"> </span>.venvs/epbd_bert_condavenv_test1
python<span class="w"> </span>setup.py<span class="w"> </span>install

conda<span class="w"> </span>install<span class="w"> </span>-c<span class="w"> </span>conda-forge<span class="w"> </span>scikit-learn<span class="w"> </span>scipy<span class="w"> </span>-y
pip<span class="w"> </span>uninstall<span class="w"> </span>triton<span class="w"> </span><span class="c1"># We did not utilize triton for underlying hardware dependency</span>

<span class="c1"># To deactivate and remove the venv</span>
conda<span class="w"> </span>deactivate
conda<span class="w"> </span>remove<span class="w"> </span>--name<span class="w"> </span>epbd_bert_condavenv_test1<span class="w"> </span>--all<span class="w"> </span>-y
conda<span class="w"> </span>remove<span class="w"> </span>-p<span class="w"> </span>.venvs/epbd_bert_condavenv_test1<span class="w"> </span>--all<span class="w"> </span>-y
</pre></div>
</div>
</section>
<section id="acknowledgements">
<h1>Acknowledgements<a class="headerlink" href="#acknowledgements" title="Link to this heading">#</a></h1>
<p>Los Alamos National Lab (LANL), T-1</p>
Expand Down Expand Up @@ -438,12 +458,18 @@ <h1>Authors<a class="headerlink" href="#authors" title="Link to this heading">#<
<section id="how-to-cite-epbd-bert">
<h1>How to cite EPBD-BERT?<a class="headerlink" href="#how-to-cite-epbd-bert" title="Link to this heading">#</a></h1>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">@article{kabir2024advancing,</span>
<span class="go"> title = {Advancing Transcription Factor Binding Site Prediction Using DNA Breathing Dynamics and Sequence Transformers via Cross Attention},</span>
<span class="go"> author = {Kabir, Anowarul and Bhattarai, Manish and Rasmussen, Kim {\O} and Shehu, Amarda and Bishop, Alan R and Alexandrov, Boian and Usheva, Anny},</span>
<span class="go"> journal = {bioRxiv},</span>
<span class="go"> pages = {2024--01},</span>
<span class="go"> year = {2024},</span>
<span class="go"> publisher = {Cold Spring Harbor Laboratory}</span>
<span class="go"> title = {Advancing Transcription Factor Binding Site Prediction Using DNA Breathing Dynamics and Sequence Transformers via Cross Attention},</span>
<span class="go"> author = {Kabir, Anowarul and</span>
<span class="go"> Bhattarai, Manish and</span>
<span class="go"> Rasmussen, Kim {\O} and</span>
<span class="go"> Shehu, Amarda and</span>
<span class="go"> Bishop, Alan R and</span>
<span class="go"> Alexandrov, Boian and</span>
<span class="go"> Usheva, Anny},</span>
<span class="go"> journal = {bioRxiv},</span>
<span class="go"> pages = {2024--01},</span>
<span class="go"> year = {2024},</span>
<span class="go"> publisher= {Cold Spring Harbor Laboratory}</span>
<span class="go"> doi = {10.5281/zenodo.11130474},</span>
<span class="go"> url = {https://www.biorxiv.org/content/10.1101/2024.01.16.575935v2}</span>
<span class="go"> }</span>
Expand Down Expand Up @@ -489,6 +515,7 @@ <h1>How to cite EPBD-BERT?<a class="headerlink" href="#how-to-cite-epbd-bert" ti
<ul class="visible nav section-nav flex-column">
<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#">Welcome to EPBD-BERT’s documentation!</a></li>
<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#resources">Resources</a></li>
<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#installation">Installation</a></li>
<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#acknowledgements">Acknowledgements</a></li>
<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#copyright-notice">Copyright notice</a></li>
<li class="toc-h1 nav-item toc-entry"><a class="reference internal nav-link" href="#license">License</a></li>
Expand Down
2 changes: 1 addition & 1 deletion docs/searchindex.js

Large diffs are not rendered by default.

42 changes: 34 additions & 8 deletions docs_builder/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This repository corresponds to the article titled **"Advancing Transcription Fac


.. figure:: ../../plots/EPBD_Arch.jpg
:width: 50%
:width: 70%
:align: center

Figure 1: Overview of the proposed EPBDxBERT framework.
Expand Down Expand Up @@ -38,6 +38,26 @@ Resources
* `Analysis Notebooks <https://github.com/lanl/EPBD-BERT/tree/main/analysis>`_


Installation
========================================
.. code-block:: shell
# Installation of virtural environment
git clone https://github.com/lanl/EPBD-BERT.git
cd EPBD-BERT
conda create -c conda-forge -p .venvs/epbd_bert_condavenv_test1 python=3.11 -y
conda activate .venvs/epbd_bert_condavenv_test1
python setup.py install
conda install -c conda-forge scikit-learn scipy -y
pip uninstall triton # We did not utilize triton for underlying hardware dependency
# To deactivate and remove the venv
conda deactivate
conda remove --name epbd_bert_condavenv_test1 --all -y
conda remove -p .venvs/epbd_bert_condavenv_test1 --all -y
Acknowledgements
========================================
Los Alamos National Lab (LANL), T-1
Expand Down Expand Up @@ -90,17 +110,23 @@ Authors
- `Anny Usheva <mailto:Anny\_[email protected]>`_: Surgery, Rhode Island Hospital and Brown University

How to cite EPBD-BERT?
==================
========================================

.. code-block:: console
@article{kabir2024advancing,
title = {Advancing Transcription Factor Binding Site Prediction Using DNA Breathing Dynamics and Sequence Transformers via Cross Attention},
author = {Kabir, Anowarul and Bhattarai, Manish and Rasmussen, Kim {\O} and Shehu, Amarda and Bishop, Alan R and Alexandrov, Boian and Usheva, Anny},
journal = {bioRxiv},
pages = {2024--01},
year = {2024},
publisher = {Cold Spring Harbor Laboratory}
title = {Advancing Transcription Factor Binding Site Prediction Using DNA Breathing Dynamics and Sequence Transformers via Cross Attention},
author = {Kabir, Anowarul and
Bhattarai, Manish and
Rasmussen, Kim {\O} and
Shehu, Amarda and
Bishop, Alan R and
Alexandrov, Boian and
Usheva, Anny},
journal = {bioRxiv},
pages = {2024--01},
year = {2024},
publisher= {Cold Spring Harbor Laboratory}
doi = {10.5281/zenodo.11130474},
url = {https://www.biorxiv.org/content/10.1101/2024.01.16.575935v2}
}
Expand Down

0 comments on commit 8f190ed

Please sign in to comment.