Skip to content

Commit

Permalink
Deployed 07b3a77 with MkDocs version: 1.5.3
Browse files Browse the repository at this point in the history
  • Loading branch information
Unknown committed Jun 21, 2024
1 parent 2e0e8d9 commit abb9436
Show file tree
Hide file tree
Showing 37 changed files with 2,349 additions and 609 deletions.
113 changes: 66 additions & 47 deletions Benchmark/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -200,33 +200,35 @@
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25Z"></path></svg>
</a>
<h1 id="class-benchmark">Class: Benchmark</h1>
<p><em>A multi-step workflow to evaluate processing steps for a specific task.</em></p>
<p><em>A multi-stage workflow to evaluate processing stage for a specific task.</em></p>
<p>URI: <a href="https://w3id.org/omnibenchmark/omni-schema/Benchmark">omni_schema:Benchmark</a></p>
<div class="mermaid"> classDiagram
class Benchmark
IdentifiableEntity &lt;|-- Benchmark

Benchmark : benchmark_yaml_spec

Benchmark : benchmarker

Benchmark : description

Benchmark : id

Benchmark : name

Benchmark : orchestrator

Benchmark --&gt; Orchestrator : orchestrator
Benchmark : software_environments

Benchmark : platform
Benchmark --&gt; SoftwareEnvironment : software_environments

Benchmark : steps
Benchmark : stages

Benchmark --&gt; Step : steps
Benchmark --&gt; Stage : stages

Benchmark : storage

Benchmark : validator
Benchmark : storage_api

Benchmark --&gt; Validator : validator
Benchmark --&gt; StorageAPIEnum : storage_api

Benchmark : version

Expand Down Expand Up @@ -257,9 +259,9 @@ <h2 id="slots">Slots</h2>
<td>direct</td>
</tr>
<tr>
<td><a href="../platform/">platform</a></td>
<td><a href="../benchmarker/">benchmarker</a></td>
<td>1..1 <br/> <a href="../String/">String</a></td>
<td>The place hosting all benchmark components</td>
<td>The name and contact details of the person responsible for this benchmark</td>
<td>direct</td>
</tr>
<tr>
Expand All @@ -269,20 +271,26 @@ <h2 id="slots">Slots</h2>
<td>direct</td>
</tr>
<tr>
<td><a href="../orchestrator/">orchestrator</a></td>
<td>1..1 <br/> <a href="../Orchestrator/">Orchestrator</a></td>
<td>The orchestrator of the benchmark</td>
<td><a href="../storage_api/">storage_api</a></td>
<td>1..1 <br/> <a href="../StorageAPIEnum/">StorageAPIEnum</a></td>
<td>The type of the storage API (i</td>
<td>direct</td>
</tr>
<tr>
<td><a href="../software_environments/">software_environments</a></td>
<td>1..* <br/> <a href="../SoftwareEnvironment/">SoftwareEnvironment</a></td>
<td>Dictionary of software environments keyed by their identifiers</td>
<td>direct</td>
</tr>
<tr>
<td><a href="../validator/">validator</a></td>
<td>1..1 <br/> <a href="../Validator/">Validator</a></td>
<td>The validator of the benchmark</td>
<td><a href="../benchmark_yaml_spec/">benchmark_yaml_spec</a></td>
<td>0..1 <br/> <a href="../String/">String</a></td>
<td>Benchmark Specification version</td>
<td>direct</td>
</tr>
<tr>
<td><a href="../steps/">steps</a></td>
<td>1..* <br/> <a href="../Step/">Step</a></td>
<td><a href="../stages/">stages</a></td>
<td>1..* <br/> <a href="../Stage/">Stage</a></td>
<td></td>
<td>direct</td>
</tr>
Expand All @@ -294,7 +302,7 @@ <h2 id="slots">Slots</h2>
</tr>
<tr>
<td><a href="../name/">name</a></td>
<td>1..1 <br/> <a href="../String/">String</a></td>
<td>0..1 <br/> <a href="../String/">String</a></td>
<td>A human-readable name for a thing</td>
<td><a href="../IdentifiableEntity/">IdentifiableEntity</a></td>
</tr>
Expand Down Expand Up @@ -335,24 +343,25 @@ <h2 id="linkml-source">LinkML Source</h2>
<h3 id="direct">Direct</h3>
<details>
<pre><code class="language-yaml">name: Benchmark
description: A multi-step workflow to evaluate processing steps for a specific task.
description: A multi-stage workflow to evaluate processing stage for a specific task.
from_schema: https://w3id.org/omnibenchmark/omni-schema
is_a: IdentifiableEntity
slots:
- version
- platform
- benchmarker
- storage
- orchestrator
- validator
- steps
- storage_api
- software_environments
- benchmark_yaml_spec
- stages
tree_root: true

</code></pre>
</details>
<h3 id="induced">Induced</h3>
<details>
<pre><code class="language-yaml">name: Benchmark
description: A multi-step workflow to evaluate processing steps for a specific task.
description: A multi-stage workflow to evaluate processing stage for a specific task.
from_schema: https://w3id.org/omnibenchmark/omni-schema
is_a: IdentifiableEntity
attributes:
Expand All @@ -367,12 +376,12 @@ <h3 id="induced">Induced</h3>
- Benchmark
range: string
required: true
platform:
name: platform
description: The place hosting all benchmark components
benchmarker:
name: benchmarker
description: The name and contact details of the person responsible for this benchmark.
from_schema: https://w3id.org/omnibenchmark/omni-schema
rank: 1000
alias: platform
alias: benchmarker
owner: Benchmark
domain_of:
- Benchmark
Expand All @@ -389,38 +398,51 @@ <h3 id="induced">Induced</h3>
- Benchmark
range: string
required: true
orchestrator:
name: orchestrator
description: The orchestrator of the benchmark.
storage_api:
name: storage_api
description: The type of the storage API (i.e. S3)
from_schema: https://w3id.org/omnibenchmark/omni-schema
rank: 1000
alias: orchestrator
alias: storage_api
owner: Benchmark
domain_of:
- Benchmark
range: Orchestrator
range: StorageAPIEnum
required: true
validator:
name: validator
description: The validator of the benchmark.
software_environments:
name: software_environments
description: Dictionary of software environments keyed by their identifiers
from_schema: https://w3id.org/omnibenchmark/omni-schema
rank: 1000
alias: validator
multivalued: true
alias: software_environments
owner: Benchmark
domain_of:
- Benchmark
range: Validator
range: SoftwareEnvironment
required: true
steps:
name: steps
inlined: true
inlined_as_list: true
benchmark_yaml_spec:
name: benchmark_yaml_spec
description: Benchmark Specification version.
from_schema: https://w3id.org/omnibenchmark/omni-schema
rank: 1000
alias: benchmark_yaml_spec
owner: Benchmark
domain_of:
- Benchmark
range: string
stages:
name: stages
from_schema: https://w3id.org/omnibenchmark/omni-schema
rank: 1000
multivalued: true
alias: steps
alias: stages
owner: Benchmark
domain_of:
- Benchmark
range: Step
range: Stage
required: true
inlined: true
inlined_as_list: true
Expand All @@ -447,10 +469,7 @@ <h3 id="induced">Induced</h3>
owner: Benchmark
domain_of:
- IdentifiableEntity
- Orchestrator
- Validator
range: string
required: true
description:
name: description
description: A human-readable description for a thing
Expand Down
11 changes: 4 additions & 7 deletions IOFile/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ <h2 id="slots">Slots</h2>
<tr>
<td><a href="../path/">path</a></td>
<td>0..1 <br/> <a href="../String/">String</a></td>
<td>The code repository hosting the module</td>
<td>The output path pattern for the IO file</td>
<td>direct</td>
</tr>
<tr>
Expand All @@ -253,7 +253,7 @@ <h2 id="slots">Slots</h2>
</tr>
<tr>
<td><a href="../name/">name</a></td>
<td>1..1 <br/> <a href="../String/">String</a></td>
<td>0..1 <br/> <a href="../String/">String</a></td>
<td>A human-readable name for a thing</td>
<td><a href="../IdentifiableEntity/">IdentifiableEntity</a></td>
</tr>
Expand All @@ -277,7 +277,7 @@ <h2 id="usages">Usages</h2>
</thead>
<tbody>
<tr>
<td><a href="../Step/">Step</a></td>
<td><a href="../Stage/">Stage</a></td>
<td><a href="../outputs/">outputs</a></td>
<td>range</td>
<td><a href="./">IOFile</a></td>
Expand Down Expand Up @@ -336,7 +336,7 @@ <h3 id="induced">Induced</h3>
attributes:
path:
name: path
description: The code repository hosting the module.
description: The output path pattern for the IO file.
from_schema: https://w3id.org/omnibenchmark/omni-schema
rank: 1000
alias: path
Expand Down Expand Up @@ -367,10 +367,7 @@ <h3 id="induced">Induced</h3>
owner: IOFile
domain_of:
- IdentifiableEntity
- Orchestrator
- Validator
range: string
required: true
description:
name: description
description: A human-readable description for a thing
Expand Down
11 changes: 5 additions & 6 deletions IdentifiableEntity/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -208,9 +208,10 @@ <h1 id="class-identifiableentity">Class: IdentifiableEntity</h1>
<div class="mermaid"> classDiagram
class IdentifiableEntity
IdentifiableEntity &lt;|-- Benchmark
IdentifiableEntity &lt;|-- Step
IdentifiableEntity &lt;|-- Stage
IdentifiableEntity &lt;|-- Module
IdentifiableEntity &lt;|-- IOFile
IdentifiableEntity &lt;|-- SoftwareEnvironment

IdentifiableEntity : description

Expand All @@ -224,9 +225,10 @@ <h2 id="inheritance">Inheritance</h2>
<ul>
<li><strong>IdentifiableEntity</strong><ul>
<li><a href="../Benchmark/">Benchmark</a></li>
<li><a href="../Step/">Step</a></li>
<li><a href="../Stage/">Stage</a></li>
<li><a href="../Module/">Module</a></li>
<li><a href="../IOFile/">IOFile</a></li>
<li><a href="../SoftwareEnvironment/">SoftwareEnvironment</a></li>
</ul>
</li>
</ul>
Expand All @@ -249,7 +251,7 @@ <h2 id="slots">Slots</h2>
</tr>
<tr>
<td><a href="../name/">name</a></td>
<td>1..1 <br/> <a href="../String/">String</a></td>
<td>0..1 <br/> <a href="../String/">String</a></td>
<td>A human-readable name for a thing</td>
<td>direct</td>
</tr>
Expand Down Expand Up @@ -331,10 +333,7 @@ <h3 id="induced">Induced</h3>
owner: IdentifiableEntity
domain_of:
- IdentifiableEntity
- Orchestrator
- Validator
range: string
required: true
description:
name: description
description: A human-readable description for a thing
Expand Down
2 changes: 1 addition & 1 deletion InputCollection/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ <h2 id="usages">Usages</h2>
</thead>
<tbody>
<tr>
<td><a href="../Step/">Step</a></td>
<td><a href="../Stage/">Stage</a></td>
<td><a href="../inputs/">inputs</a></td>
<td>range</td>
<td><a href="./">InputCollection</a></td>
Expand Down
Loading

0 comments on commit abb9436

Please sign in to comment.