Skip to content

Commit

Permalink
Update YAML schema documentation page
Browse files Browse the repository at this point in the history
  • Loading branch information
EdmundGoodman committed Apr 29, 2024
1 parent 2e9eb59 commit d3a35fd
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions docs/yaml_schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,19 @@ hide:

# YAML Schema

The YAML schema is the key abstraction which allows similar workflows for
performance analysis to be captured by this single tool.

Pydantic is used to parse the YAML file, and as such a full description of the
YAML schema can be seen in the entity-relationship diagram of the Pydantic
model, shown below.

<figure markdown="span">
![Viewing run configurations](./assets/images/uml/yaml_model){ loading=lazy }
![Viewing run configurations](./assets/images/uml/yaml_model.png){ loading=lazy }
<figcaption>A diagram of the Pydantic model used to parse the YAML schema, generated using erdantic.</figcaption>
</figure>

## Run Configurations
<!-- ## Run Configurations
## Test Benches
Expand All @@ -22,4 +29,4 @@ hide:
#### Metrics
#### Plotting
#### Plotting -->

0 comments on commit d3a35fd

Please sign in to comment.