2.3 Hello World


MLHub supports any number of commands that are exposed through the individual model packages. MLHub itself implements the following core commands. Note that everything from the # to the end of the line in the following code block is ignored (it’s a comment). Replace <model> and <new> with actual model names.

$ ml                         # Summary of commands supported by ml.
$ ml configure               # Configure the mlhub package itself.
$ ml available               # List of currated models on the MLHub repository.
$ ml installed               # List of models installed locally.
$ ml install   <model>       # Install a model.
$ ml configure <model>       # Install the model's required dependencies.
$ ml readme    <model>       # View the author's introduction of the model.
$ ml commands  <model>       # List commands supported by the model.
$ ml rename    <model> <new> # Rename an installed model.
$ ml uninstall <model>       # Uninstall the model and (optionally) model cache.

Once MLHub is installed run one of the available packages. A simple one is kmeans as described in Chapter 7 which demonstrates the use of the k-means algorithm for undertaking a cluster analysis. The following sequence of commands illustrate the typical workflow for many MLHub packages:

$ ml install   kmeans       # Install the pre-built model named 'kmeans'.
$ ml configure kmeans       # Configure any dependencies for the model.
$ ml readme    kmeans       # View background information about the model.
$ ml commands  kmeans       # List the commands supported by the model.
$ ml demo      kmeans       # Run the demonstration of the pre-built model.

Different packages will have different system dependencies and these will be installed by the configure command. After configuration it is useful to review the packages commentary from the readme. The list of commands supported by the package is provided by commands.

Most packages will support the demo command. The command will demonstrate the capabilities of the package.

Some packages also support the gui command which will provide a graphical interface to the package’s functionality.

$ ml gui  <model>         # Graphical display to utilise the model.

The remaining commands supported by a package then provide specific functionality usually in a manner suitable for command pipelines (see Section 4). A list of the individual package commands is provided through the commands command.

Your donation will support ongoing availability and give you access to the PDF version of this book. Desktop Survival Guides include Data Science, GNU/Linux, and MLHub. Books available on Amazon include Data Mining with Rattle and Essentials of Data Science. Popular open source software includes rattle, wajig, and mlhub. Hosted by Togaware, a pioneer of free and open source software since 1984. Copyright © 1995-2022 Graham.Williams@togaware.com Creative Commons Attribution-ShareAlike 4.0