Skip to content

Latest commit

 

History

History
50 lines (33 loc) · 2.19 KB

README.md

File metadata and controls

50 lines (33 loc) · 2.19 KB
Raw

MLJExampleInterface.jl

This repository is a template for creating repositories that contain glue code between (i) packages providing machine learning algorithms; and (ii) the machine learning toolbox MLJ - that is, for so-called interface-only packages.

When to use this template

This template is intended for use when a package providing a machine learning model algorithm is not hosting the code that implements the MLJ model API, and a separate package for this purpose is to be created. This repo is itself a working implementation but should be used in conjunction with the more detailed model implementation guidelines.

How to use this template

  1. Clone this repository or use it as a template if available from your organization.

  2. Rename this repository, replacing the word "Example" with the name of the model-providing package.

  3. Develop the contents of src/MLJExampleInterface.jl appropriately.

  4. Rename src/MLJExampleInterface.jl appropriately.

  5. Remove Example from Project.toml and instead add the model-providing package.

  6. GENERATE A NEW UUID in Project.toml and change the Project.toml name and author appropriately.

  7. You may want to remove the Distributions test dependency if you don't need it.

  8. Replace every instance of "Example" in this README.md with the name of the model-providing package and adjust the organization name in the link.

  9. Remove everything in this REAMDE.md except what is below the line you are currently reading 😉.

MLJ.jl <--> Example.jl

Repository implementing the MLJ model interface for models provided by Example.jl.

Linux Coverage
Build Status Coverage