search

mintproject / mic

Model Insertion Checker
https://mic-cli.readthedocs.io/en/latest/
5 stars 3 forks source link

Improve Help message #179

Closed dgarijo closed 4 years ago

dgarijo commented 4 years ago

The current help message is:

Usage: mic encapsulate [OPTIONS] COMMAND [ARGS]...

  Command to encapsulate your Model Configuration

Options:
  --help  Show this message and exit.

Commands:
  start       Create a Linux environment. The working directory must contains
              all the files required in the execution

  trace       Trace any command line and extract the information about the
              execution

  parameters  Add parameters mic.yaml
  configs     Select configuration file(s) for your model. If there are any
  inputs      Detect the inputs and write them into mic.yaml
  outputs     Detect the outputs and write them into mic.yaml
  wrapper     Generate the directory structure and commands required to run
              your model component using the information from the previous
              steps

  run         Run your Model Component using the MIC Wrapper
  publish     Publish your code on GitHub, your image on DockerHub and your
              Model Configuration on MINT Model Catalog.

There are a few typos and confusing sentences in my opinion. Can we please change it for the one below?:

Usage: mic encapsulate [OPTIONS] COMMAND [ARGS]...

  Command to encapsulate your model and a Model Configuration

Options:
  --help  Show this message and exit.

Commands:
  start       Create a Linux environment to run your model. The working directory selected must                                           
              contain all the files required for the execution of your model
  trace       Trace any command line and extract the information about your model
              execution
  parameters  Expose parameters into the mic.yaml file
  configs     Select configuration file(s) for your model (if applicable)
  inputs      Expose model inputs into the mic.yaml file
  outputs    Expose model outputs into the mic.yaml
  wrapper   Generate the directory structure and commands required to run
              your model component using the information from the previous
              steps
  run         Run your Model Configuration through the the MIC Wrapper generated
             the previous step
  publish     Publish your code on GitHub, your image on DockerHub and your
              Model Configuration on MINT Model Catalog.
issue-label-bot[bot] commented 4 years ago

Issue-Label Bot is automatically applying the label feature_request to this issue, with a confidence of 0.95. Please mark this comment with :thumbsup: or :thumbsdown: to give our bot feedback!

Links: app homepage, dashboard and code for this bot.

dgarijo commented 4 years ago

Closed in develop (closing here for clarity)