Describe use of YAML

[bobturneruk]

Fixes #163.

Description

Adds a brief description of how YAML allows users to declaratively specify models.

Status

Work in progress

On the right (delete these after selection):

• Select a reviewer if ready for review. Use the suggested one if unsure.

Types of changes

• Non-breaking change (fix or new feature that would not break existing functionality).

[codecov-commenter]

Codecov Report

Merging #212 (de09280) into main (0ec2513) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #212   +/-   ##
=======================================
  Coverage   89.93%   89.93%           
=======================================
  Files          49       49           
  Lines        4737     4737           
=======================================
  Hits         4260     4260           
  Misses        477      477           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0ec2513...de09280. Read the comment docs.

[haipinglu]

@bobturneruk I'll give a virtual talk on PyKale next Tuesday so hope to have this merged this week for another release. Thanks.

[bobturneruk]

Hopefully this is a reasonable technical description of how PyKale uses YAML.

Perhaps a snazzy static website e.g. https://monai.io/, https://github.com/Project-MONAI/project-monai.github.io to really "sell" this feature (and others) would be a nice future development if we can get the design skills in the team. If so, a separate discussion / issue would be appropriate.

[haipinglu]

Hopefully this is a reasonable technical description of how PyKale uses YAML.

Perhaps a snazzy static website e.g. https://monai.io/, https://github.com/Project-MONAI/project-monai.github.io to really "sell" this feature (and others) would be a nice future development if we can get the design skills in the team. If so, a separate discussion / issue would be appropriate.

Maybe part of the proposal.