filipg/gonito
1
0
Fork 1
Code Issues 1 Pull Requests Releases Wiki Activity

Add how-to on metadata

Browse Source
This commit is contained in:
Filip Gralinski 2018-11-03 18:02:27 +01:00
parent 37125b8326
commit e51125ef5d
1 changed files with 35 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
templates/challenge-how-to.hamlet
View File

@ -124,11 +124,43 @@ $maybe token <- mToken
<h2>Submission metadata <h2>Submission metadata
<p>Gonito can take the description, tags and parameters of a submission from a number of sources (in order of precedence): <p>Gonito can take the metadata (description, tags, parameters) of a submission from a number of sources (in order of precedence):
<ol> <ol>
<li>submission form (when submitting manually), <li>the YAML files specified in the <tt>param-files</tt> field of the <tt>gonito.yaml</tt> file
<li>git commit message, <ul>
<li>only applicable for parameters,
<li><tt>gonito.yaml</tt> will be always skipped even if matches a mask given in the <tt>param-files</tt> field,
<li>parameters blacklisted in the <tt>unwanted-params</tt> field of the <tt>gonito.yaml</tt> file will be discarded;
<li><tt>gonito.yaml</tt> file committed to the repository
<ul>
<li>description given in the <tt>description</tt> field,
<li>tags given in <tt>tags</tt> field,
<li>parameters given in <tt>params</tt> field,
<li>names of output files (only for parameters) <li>names of output files (only for parameters)
<ul>
<li>e.g. if the output file is <tt>out-epochs=10,learning-rate=0.01.tsv</tt>, then parameters <i>epochs</i>=10 and <i>learning-rare</i>=0.01 will be extracted;
<li>submission form (when submitting manually);
<li>git commit message
<ul>
<li>description taken from the first paragraph
<li>tags taken from a line starting with <tt>tags:</tt>
<p>Here is an example of <tt>gonito.yaml</tt>, in which all metadata could be given:
<pre>
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
<p>It might seem a little bit complicated, but you could simply use the method which is the most convenient for you. <p>It might seem a little bit complicated, but you could simply use the method which is the most convenient for you.