This repository contains the
cookiecutter
template for generating a repository that provides boilerplates touching
on the differing components of an end-to-end ML project. This template
is dedicated for AI Singapore's on-premise environment, and where
Run:ai is used as the MLOps platform.
To use the template and create a repository, you would need to install
the cookiecutter
CLI, say within a virtual environment and pass the
URL of this template as an argument, like such:
$ pip install cookiecutter
$ cookiecutter https://github.com/aisingapore/ml-project-cookiecutter-onprem-runai
You will then be prompted to provide inputs.These inputs will be used to
populate different parts of the repository to be generated by
cookiecutter
.
Parameter | Detail | Default | Regex Reference |
---|---|---|---|
project_name |
Name of project that will be the header for the README.md . Input to start with alphabet. Only whitespace as separators. |
Name of project (not name of repository). Use whitespace instead of underscores or hyphens. | Link |
description |
A short description of the project that will be populated in README.md . Max of 72 characters. |
A short description of the project. | NIL |
repo_name |
Name of the repository folder. Input to start with alphabet characters. No whitespaces or underscores are allowed. | project_name where whitespaces and underscores are replaced with hyphens. |
Link |
src_package_name |
Name of the source code's package under src . Input to start with alphabet characters. No whitespaces or hyphens are allowed. |
repo_name where hyphens are replaced with underscores. |
Link |
src_package_name_short |
The alias for the source code's package. Input to start with alphabet characters. No whitespaces or hyphens are allowed. | src_package_name |
Link |
runai_proj_name |
The RunAI namespace used by the project - the project name that you're sending jobs to. | The RunAI namespace used by the project. | NIL |
harbor_registry_project_path |
Path of the Harbor registry repository for your container images to be located under. Cannot end with a slash character. | Path of the project's container registry on Harbor. | Link |
author_name |
Your alias or project team's name. Relatively arbitrary. No hyphens are allowed. | Your alias or project team's name. | Link |
Following the creation of your repository,
initialise it with Git, push it to a
remote, and follow its
README.md
document for a full guide on its usage.