Join GitHub today
GitHub is home to over 36 million developers working together to host and review code, manage projects, and build software together.Sign up
describe "meta" field in stage file and that we are preserving comments #306
referenced this issue
May 9, 2019
Hi @algomaster99, sure! So, here is the section that should be reviewed and updated is this one https://dvc.org/doc/user-guide/dvc-file-format (btw, @efiop does it make sense to include a comment with a link to this doc by default, when we generate the stage file). It now describes the schema of the file, and until that fix by @Suor DVC was throwing an exception if there were fields with an unknown names. Also DVC was removing any comments in those stage files before, every time you run the
After the fix DVC now preserves comments between runs and any other updates it makes to .dvc files. And you can use
Let me know if it makes sense.
@algomaster99 I am the author of the change in dvc. Here are my two cents:
Here is an updated dvc file sample:
# This as an example starting comment # cmd could be formatted like below, newlines will mean space when run, # use | instead of > to make them literal. cmd: > python cmd.py input.data output.data metrics.json # YAML multi-line formatting is exlplained here - https://yaml-multiline.info/ deps: - md5: da2259ee7c12ace6db43644aef2b754c path: cmd.py # A line comment example - md5: e309de87b02312e746ec5a500844ce77 path: input.data md5: 521ac615cfc7323604059d81d052ce00 outs: - cache: true md5: 70f3c9157e3b92a6d2c93eb51439f822 metric: false path: output.data - cache: false md5: d7a82c3cdfd45c4ace13484a931fc526 metric: type: json xpath: AUC path: metrics.json locked: True meta: # optional key to contain arbitrary user data author: name: Alex email: firstname.lastname@example.org anykey: anydata # "meta: some-string" is also possible it doesn't have to contain dict
Hope this helps more than scares with its volume).