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
Polyaxon is used as the MLOps platform.
To use the template and create a repository, you would need to
install the cruft CLI
, say within a virtual environment and pass the URL of this template as
an argument, like such:
$ pip install cruft
$ cruft create https://github.com/aisingapore/ml-project-cookiecutter-onprem-polyNote: cruft can quickly validate whether or not a project is using
the latest version of a template using cruft check.
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 | Choices |
|---|---|---|---|
project_name |
Name of project that will be the header for the README.md. Recommended for input to start with alphabet characters. Use whitespace instead of underscores or hyphens. |
NIL | NIL |
description |
A short description of the project that will be populated in README.md. |
A short description of the project. | NIL |
repo_name |
Name of the repository folder. Recommended for input to start with alphabet characters. No whitespaces are allowed. | project_name where whitespaces and underscores are replaced with hyphens. |
NIL |
src_package_name |
Name of the source code's package under src. Recommended for input to start with alphabet characters. No whitespaces or hyphens are allowed. |
repo_name where hyphens are replaced with underscores. |
NIL |
src_package_name_short |
The alias for the source code's package. | src_package_name |
NIL |
harbor_registry_project_path |
Path of your project's Harbor registry repository. | NIL | NIL |
author_name |
Your alias or project team's name. Underscore delimited if you're using personal Harbor subdirectories (case sensitive). | NIL | NIL |
open_source_license |
Open source license to be populated within repository. When in doubt, select [3]. | NIL | 1 - MIT, 2 - BSD-3-Clause, 3 - No license file |
Note: If invalid inputs are provided, cruft
(with cookiecutter in the backend) will exit and
the repository will not be generated.
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.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent