RSDK-9945: edits for inline docs #10
Conversation
| } |
There was a problem hiding this comment.
👍 Hooray, having POSIX-compliant newlines at the end of files! I believe @Rob1in's IDE is configured to put them in from now on, at which point we should have fewer of these spurious diffs.
README.md
Outdated
| ```json | ||
| { | ||
| "model_path": "${packages.ml_model.[myMLModel]}/my_model.pt", | ||
| "label_path": "${packages.ml_model.[myMLModel]}/labels.txt" |
There was a problem hiding this comment.
I'm open to disagreement on this, but I'd remove the square brackets. We want to indicate to the user that the curly braces should literally be there in the config, and I think adding brackets you're supposed to remove confuses this.
There was a problem hiding this comment.
perfectly fine, removed the square brackets
meta.json
Outdated
| "model": "viam:mlmodel:torch-cpu" | ||
| "model": "viam:mlmodel:torch-cpu", | ||
| "markdown_link": "README.md#example-configuration", | ||
| "short_description": "An ML Model Service that can run PyTorch models of a standard format" |
There was a problem hiding this comment.
Is "of" the right word at the end? I would have gone with "in" but don't feel strongly.
There was a problem hiding this comment.
I am not the best at English so I defer to you
Adds the meta.json and README edits for inline docs
linting complained about missing "extra" fields in the methods