Skip to content
Simon Zhao edited this page Jul 14, 2019 · 6 revisions

Welcome to the mlhub wiki!

Install a MLHUB package

Install a package from MLHUB repo

$ ml available  # Get a list of available packages collected at MLHUB repo.
The repository 'https://mlhub.ai/' provides the following models:

animate                  1.0.7  Tell a data narative through animations     
audit                    2.2.1  Classic financial audit predictive classific...
barchart                 2.0.0  Demonstrate the concept of barcharts.       
beeswarm                 1.0.0  Demonstrate the concept of bee swarm charts.
clothes                  1.2.0  Clothes recommendation using CNN/SVM.       
colorize                 1.2.0  Demonstrate the concept of photo colorizatio...
pets                     1.2.0  Dogs and cats image classification using ker...
iris                     2.1.0  Classical iris plant species classifier.    
movies                   1.2.0  Movie recommendation using the SAR algorthm.
objects                  1.4.1  Image object recognition using resnet152.   
ports                    1.1.7  Demostrate the concept of visualising data. 
rain                     2.1.0  Predict rain tomorrow using.                
scatter                  1.2.2  Demonstrate the concept of scatter plots.   

To locally install a model downloaded from an ML Hub repository:

  $ ml install <model>


$ ml install animate  # Install the 'animate' package from MLHUB repo

Install a package hosted on GitHub

Assume there is a file called MLHUB.yaml at the top level of the repo describing the meta data of the package.

$ ml install gjwgit/animate          # Install gjwgit/animate
$ ml install gjwgit/animate@dev      # Install gjwgit/animate at the 'dev' branch
$ ml install gjwgit/animate@0001ea4  # Install gjwgit/animate at the commit '0001ea4'
$ ml install gjwgit/animate#6        # Install gjwgit/animate from pull request #6
$ ml install github:gjwgit/animate   # Install gjwgit/animate and explicitly specify it is from GitHub

If the MLHUB.yaml is not at the root directory of the repo, its path needs to be explicitly specified:

$ ml install gjwgit/animate@0001ea4:xyz/MLHUB.yaml  # Install gjwgit/animate at the commit '0001ea4'

Install a package hosted on GitLab or Bitbucket

Now we provide similar but limited support for GitLab, and it need extra prefix to indicate the package is from GitLab or Bitbucket instead of the default GitHub.

$ ml install gitlab:gjwgit/animate          # Install gjwgit/animate from GitLab
$ ml install gitlab:gjwgit/animate@dev      # Install gjwgit/animate at the 'dev' branch
$ ml install gitlab:gjwgit/animate@0001ea4  # Install gjwgit/animate at the commit '0001ea4'
$ ml install gitlab:gjwgit/animate@dev:zyx/MLHUB.yaml  # Specify MLHUB.yaml

$ ml install bitbucket:gjwgit/animate          # Install gjwgit/animate from Bitbucket
$ ml install bitbucket:gjwgit/animate@dev      # Install gjwgit/animate at the 'dev' branch
$ ml install bitbucket:gjwgit/animate@0001ea4  # Install gjwgit/animate at the commit '0001ea4'