This is a minimal template for developing new modules in the AI4OS Platform. It uses Cookiecutter to generate the templates. This template is based on the Cookiecutter Data Science template.
This repository provides a minimal version of the AI4OS Hub template: Simple, minimal template, with the minimum requirements to integrate your AI model in AI4OS Hub.
There are other versions of the template:
-
advanced: this is a more advanced template. It makes more assumptions on how to structure projects and adds more files. If you want to integrate an already existing AI code, which you still want to keep in a separate repository, this template is for you.
-
child-module: this template specifically tailors to users performing a retraining of an existing at AI4OS-Hub module. It only creates a Docker repo whose container is based on an existing module's Docker image.
To create a new template of your project, either
- install cookiecutter and run it with this template:
pip install cookiecutter
cookiecutter https://github.com/ai4os/ai4-template.git- OR visit our Templates Hub service: https://templates.cloud.ai4eosc.eu/ and select the template
Once you answer all the questions, your repository <your-project> with the python package <your_project> will be created.
This is what the folder structures look like:
<your-project>
##############
│
├── Dockerfile <- Describes main steps on integration of DEEPaaS API and
│ <your_project> application in one Docker image
│
├── Jenkinsfile <- Describes basic Jenkins CI/CD pipeline (see .sqa/)
│
├── LICENSE <- License file
│
├── README.md <- The top-level README for developers using this project.
│
├── VERSION <- <your_project> version file
│
├── .sqa/ <- CI/CD configuration files
│
├── <your_project> <- Source code for use in this project.
│ │
│ ├── __init__.py <- Makes <your_project> a Python module
│ │
│ ├── api.py <- Main script for the integration with DEEPaaS API
│ |
│ ├── config.py <- Configuration file to define Constants used across <your_project>
│ │
│ └── misc.py <- Misc functions that were helpful accross projects
│
├── data/ <- Folder to store the data
│
├── models/ <- Folder to store models
│
├── tests/ <- Scripts to perfrom code testing
|
├── metadata.json <- Metadata information propagated to the AI4OS Hub
│
├── pyproject.toml <- a configuration file used by packaging tools, so <your_project>
│ can be imported or installed with `pip install -e .`
│
├── requirements.txt <- The requirements file for reproducing the analysis environment, i.e.
│ contains a list of packages needed to make <your_project> work
│
├── requirements-test.txt <- The requirements file for running code tests (see tests/ directory)
│
└── tox.ini <- Configuration file for the tox tool used for testing (see .sqa/)
More extended documentation can be found here. If you want to look at a minimal app using this template structure check demo_app.
Once you update the template, please, update this README.md and VERSION file with the corresponging, incremented version following SymVer specs.
Once commited, please, verify in the remote repository that the entry "__ai4_template" in the cookiecutter.json file was updated properly by the GitHub Action. The convention for the "__ai4_template" entry is to provide the template repository name, slash '/' closest version of the template, i.e. it should look like:
"__ai4_template": "ai4-template/2.1.0"
OR
"__ai4_template": "ai4-template-adv/2.1.0"
OR
"__ai4_template": "ai4-template-child/2.1.0"