Skip to content

Fair tutorial guidelines#48

Open
john-shepherdson wants to merge 10 commits intonextfrom
FAIR-tutorial-guidelines
Open

Fair tutorial guidelines#48
john-shepherdson wants to merge 10 commits intonextfrom
FAIR-tutorial-guidelines

Conversation

@john-shepherdson
Copy link
Collaborator

Added initial versions of:

  • Creating a FAIR Benchmark and Metrics (needs review by Allyson)
  • How create a test (service) following the FTR API (needs a lot more detail from Daniel)
  • Defining and Running a FAIR Benchmark Assessment Algorithm (needs review by Mark)

The three tutorials are linked by (back)references.

I was unable to preview them in my environment, so cannot be sure they render as expected.

@dgarijo
Copy link
Collaborator

dgarijo commented Mar 10, 2026

Thanks, I will review next week.

@MarekSuchanek
Copy link
Member

@john-shepherdson please fix the issues during the build:

/home/runner/work/docs/docs/docs/commons/fair/tutorials/create-benchmark.rst:247: WARNING: undefined label: 'tutorial_create_metric_tests' [ref.ref]
/home/runner/work/docs/docs/docs/commons/fair/tutorials/define-run-scoring-algorithm.rst:31: WARNING: undefined label: 'tutorial_create_metric_tests' [ref.ref]

If CI is not passing, we will not be merging this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants