Skip to content

Commit

Permalink
added instructions to run pipeline
Browse files Browse the repository at this point in the history
  • Loading branch information
stkmrc committed Sep 5, 2024
1 parent 1d23237 commit 124e035
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions docs/source/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,38 @@ More details can be found in section :doc:`evaluation`.

In the future, other prior knowledge can be incorporated in the pipeline to allow for evaluation with binary classification metrics and as an additional control method.

Installation
------------

You need to have Docker, Java, and Viash installed. Follow `these instructions <https://openproblems.bio/documentation/fundamentals/requirements/>`_ to install the required dependencies.

Download resources
------------------

.. code-block:: bash
git clone [email protected]:openproblems-bio/task_grn_benchmark.git
cd task_grn_benchmark
# download resources
scripts/download_resources.sh
Infer a GRN
-----------

.. code-block:: bash
viash run src/methods/dummy/config.vsh.yaml -- --multiomics_rna resources/grn-benchmark/multiomics_rna.h5ad --multiomics_atac resources/grn-benchmark/multiomics_atac.h5ad --prediction output/dummy.csv
Similarly, run the command for other methods.

Evaluate a GRN
--------------

.. code-block:: bash
scripts/run_evaluation.sh --grn resources/grn-benchmark/grn_models/collectri.csv
Similarly, run the command for other GRN models.

0 comments on commit 124e035

Please sign in to comment.