Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add figure of multiple tasks #351

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions documentation/_figures/_fig_multiple_task_structure.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
```{mermaid}
%%| label: fig-task-structure
%%| fig-cap: "The structure of an OpenProblems task. **Legend**: Grey rectangles are HDF5-backed AnnData (`.h5ad`) files. Purple rhomboids are Viash components."
%%| cap-location: margin
graph LR
loader[/Dataset<br/>loader/]:::component
dataset[Dataset]:::anndata
loader --> dataset

processor0[/Processor/]:::component
processed0[Processed<br/>data]:::anndata
method0[/Method/]:::component
output0[Output]:::anndata
metric0[/Metric/]:::component
score0[Score]:::anndata
dataset --- processor0 --> processed0 --- method0 --> output0 --- metric0 --> score0

processor1[/Processor/]:::component
processed1[Processed<br/>data]:::anndata
method1[/Method/]:::component
output1[Output]:::anndata
metric1[/Metric/]:::component
score1[Score]:::anndata
dataset --- processor1 --> processed1 --- method1 --> output1 --- metric1 --> score1

processor2[/Processor/]:::component
processed2[Processed<br/>data]:::anndata
method2[/Method/]:::component
output2[Output]:::anndata
metric2[/Metric/]:::component
score2[Score]:::anndata
dataset --- processor2 --> processed2 --- method2 --> output2 --- metric2 --> score2

processor3[/Processor/]:::component
processed3[Processed<br/>data]:::anndata
method3[/Method/]:::component
output3[Output]:::anndata
metric3[/Metric/]:::component
score3[Score]:::anndata
dataset --- processor3 --> processed3 --- method3 --> output3 --- metric3 --> score3

```
3 changes: 3 additions & 0 deletions documentation/fundamentals/philosophy.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ To define benchmarking tasks, OpenProblems incorporates the principles of the Co

{{< include ../_figures/_fig_task_structure.qmd >}}

{{< include ../_figures/_fig_multiple_task_structure.qmd >}}


AnnData, short for "Annotated Data", is a file format designed for handling annotated, high-dimensional biological data [@virshup2021anndataannotateddata]. In OpenProblems, AnnData serves as the standard data format for both input and output files of components, ensuring a consistent and seamless exchange of data between different components of the benchmarking pipelines.

Viash is a meta-framework which allows generating modular {{< glossary Nextflow >}} components and workflows from Python and R scripts [@cannoodt2021viashfromscripts]. Viash components are used in OpenProblems for creating dataset loaders, dataset processors, methods, and metrics, enabling developers to focus on the core functionality of their components without worrying about the chosen pipeline framework (i.e. Nextflow).
Expand Down
Loading