search

hubverse-org / hubDocs

https://hubverse.io
5 stars 6 forks source link

Correct description of required model-output subdirectory structure #116

Closed annakrystalli closed 4 months ago

annakrystalli commented 5 months ago

Currently the documentation on the expected model-output subdirectory structure on page /user-guide/model-output.html is incorrect

It show the required structure to erroneously be:

team1-modela
   <round-id1>.csv (or parquet, etc)
   <round-id2>.csv (or parquet, etc)
team1-modelb
   <round-id1>.csv (or parquet, etc)
team2-modela
   <round-id1>.csv (or parquet, etc)

when it should be:

team1-modela
   <round-id1>-<model_id>.csv (or parquet, etc)
   <round-id2>-<model_id>.csv (or parquet, etc)
team1-modelb
   <round-id1>-<model_id>.csv (or parquet, etc)
team2-modela
   <round-id1>-<model_id>.csv (or parquet, etc)
annakrystalli commented 5 months ago

This might also be a good place to re-iterate that model_id = team_abbr-model_abbr.

mmkerr commented 4 months ago

Resolved with PR #119