Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/ai4os/ai4-template-child

Template to create AI modules derived from those hosted in AI4OS-Hub

https://github.com/ai4os/ai4-template-child

Science Score: 13.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ○
    .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (13.6%) to scientific vocabulary
Last synced: 9 months ago · JSON representation

Repository

Template to create AI modules derived from those hosted in AI4OS-Hub

Basic Info
  • Host: GitHub
  • Owner: ai4os
  • License: mit
  • Language: Python
  • Default Branch: main
  • Size: 379 KB
Statistics
  • Stars: 0
  • Watchers: 4
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Created about 2 years ago · Last pushed almost 2 years ago
Metadata Files
Readme License

README.md

logo

AI4OS Hub Modules Template (child-module)

For users

This is template specifically tailored 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. It uses Cookiecutter to generate the templates.

There are other versions of the template: * main: this is a minimal version of the AI4OS Hub template: Simple template, with the minimum requirements to integrate your AI model in AI4OS Hub.

  • 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.

To create a new template of your project, either

  • install cookiecutter and run it with this template: bash pip install cookiecutter cookiecutter https://github.com/ai4os/ai4-template-child.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> will be created.

This is what the folder structures look like:

```

├─ Dockerfile <- Describes main steps on integration of DEEPaaS API and │ application in one Docker image │ ├─ Jenkinsfile <- Describes basic Jenkins CI/CD pipeline │ ├─ LICENSE <- License file │ ├─ README.md <- README for developers and users. │ └─ metadata.json <- Defines information propagated to the DEEP Marketplace ```

More extended documentation can be found here.

For developers

Once you update the template, please, update this README.md, and especially cookiecutter.json file and "__ai4_template" entry with the corresponging, incremented version. The convention for the "__ai4_template" entry is to provide the template repository name, slash '/' closest version of the template, following SymVer specs, e.g.

"__ai4_template": "ai4-template/2.1.0" OR "__ai4_template": "ai4-template-adv/2.1.0" OR ``` "_ai4template": "ai4-template-child/2.1.0"

Owner

  • Name: AI4OS
  • Login: ai4os
  • Kind: organization
  • Email: ai4eosc-po@listas.csic.es

AI4OS is the software powering the AI4EOSC platform

GitHub Events

Total
Last Year

Dependencies

{{ cookiecutter.__repo_name }}/.sqa/docker-compose.yml docker
{{ cookiecutter.__repo_name }}/Dockerfile docker
  • ai4oshub/{{ latest build
requirements.txt pypi
  • cookiecutter *
  • mkdocs *
  • mkdocs-cinder *
  • pytest *
  • requests *
  • urllib *