cookiecutter.json

{
    "project_name": "My Project",
    "description": "A short description of the project.",
    "repo_name": "{{ cookiecutter.project_name.lower().replace(' ', '-').replace('_', '-') }}",
    "src_package_name": "{{ cookiecutter.repo_name.replace('-', '_') }}",
    "src_package_name_short": "{{ cookiecutter.src_package_name }}",
    "platform": ["onprem", "gcp"],
    "orchestrator": ["runai", "polyaxon", "none"],
    "proj_name": "sample-project",
    "registry_project_path": "registry.domain.tld/sample-project/my-project",
	"problem_template": ["base", "cv", "nlp", "tabular"],
    "author_name": "AISG",
    "__prompts__": {
        "project_name": "project_name - Name of project that will be the header for the README.md. Input to start with alphabet. Only whitespace as separators.",
        "description": "description - A short description of the project that will be populated in README.md. Max of 72 characters.",
        "repo_name": "repo_name - Name of repository. Name of the repository folder. Input to start with alphabet characters. No whitespaces or underscores are allowed.",
        "src_package_name": "src_package_name - Name of the source code's package under the src folder. Input to start with alphabet characters. No whitespaces or hyphens are allowed.",
        "src_package_name_short": "src_package_name_short - The alias for the source code's package. Input to start with alphabet characters. No whitespaces or hyphens are allowed.",
        "platform": {
            "__prompt__": "platform - The platform the project is running on.",
            "onprem": "onprem - On premise",
            "gcp": "gcp - Google Cloud Platform"
        },
        "orchestrator": {
            "__prompt__": "orchestrator - The orchestrator the project is using.",
            "runai": "runai - Run:AI",
            "polyaxon": "polyaxon - Polyaxon (for legacy purposes, not implemented yet)",
            "noorch": "noorch - No orchestrator (not implemented yet)"
        },
        "proj_name": "proj_name - The project name used in by the repository. If you're using Run:AI, this will be the Run:AI project name used by the repository.",
        "registry_project_path": "registry_project_path - Path of the registry repository for your container images to be located under. Cannot end with a slash character.",
		"problem_template": {
            "__prompt__": "problem_template - Initialise the repository with a default problem statement.",
            "base": "base - Base template with no model packages",
            "cv": "cv - Computer Vision (MNIST with Pytorch)",
            "nlp": "nlp - Natural Language Processing (not implemented yet)",
            "tabular": "tabular - Tabular data (not implemented yet)"
        },
        "author_name": "author_name - Your alias or project team's name. Relatively arbitrary. No hyphens are allowed."
    }
}