Skip to content

Writing a Howto

Shahin Saadati edited this page Apr 12, 2022 · 2 revisions

A howto in this repository is referred to a comprehensive and end-to-end example that uses a given dataset. In most cases the goal of a howto is to show how to create training and prediction pipelines to train a model and to use and evaluate it continuously.

There are not a lot of guidelines about a howto. A howto can contain different python, or java files, or shell scripts. However these files are expected in any howto example:

  • An overview.md file which goes over the example in details and explains different aspects of it.
  • An artifact.yaml file as described here.