diff --git a/templates/challenge-how-to.hamlet b/templates/challenge-how-to.hamlet index 70ae7b4..f624690 100644 --- a/templates/challenge-how-to.hamlet +++ b/templates/challenge-how-to.hamlet @@ -124,11 +124,43 @@ $maybe token <- mToken

Submission metadata -

Gonito can take the description, tags and parameters of a submission from a number of sources (in order of precedence): +

Gonito can take the metadata (description, tags, parameters) of a submission from a number of sources (in order of precedence):

    -
  1. submission form (when submitting manually), -
  2. git commit message, +
  3. the YAML files specified in the param-files field of the gonito.yaml file +
      +
    • only applicable for parameters, +
    • gonito.yaml will be always skipped even if matches a mask given in the param-files field, +
    • parameters blacklisted in the unwanted-params field of the gonito.yaml file will be discarded; +
    • gonito.yaml file committed to the repository +
        +
      • description given in the description field, +
      • tags given in tags field, +
      • parameters given in params field,
      • names of output files (only for parameters) +
          +
        • e.g. if the output file is out-epochs=10,learning-rate=0.01.tsv, then parameters epochs=10 and learning-rare=0.01 will be extracted; +
        • submission form (when submitting manually); +
        • git commit message +
            +
          • description taken from the first paragraph +
          • tags taken from a line starting with tags: + +

            Here is an example of gonito.yaml, in which all metadata could be given: + +

            +  description: This my brilliant solution
+  tags:
+  \  - neural-network
+  \  - left-to-right
+  params:
+  \  epochs: 10
+  \  learning-rate: 0.01
+  unwanted-params:
+  \  - model-file
+  \  - vocab-file
+  param-files:
+  \  - "*.yaml"
+  \  - config/*.yaml
 
 
            It might seem a little bit complicated, but you could simply use the method which is the most convenient for you.