odtp.yml

# Schema version for tracking updates to the schema format
schema-version: "v0.5.0"

# Component Information
component-name: odtp-component-example
component-version: "v0.1.7"
component-license: AGPL-3.0
component-type: ephemeral
component-description: ODTP component to download a HF_DATASET
component-authors:
  - name: Carlos Vivar Rios
    orcid: "https://orcid.org/0000-0002-8076-2034"
component-repository:
  url: "https://github.com/odtp-org/odtp-component-example"
  doi: null
component-docker-image: "caviri/odtp-component-example:v0.1.7"
tags:
  - huggingface
  - testing
  - example

# Tool Information
tools:
  - tool-name: tool-example
    tool-authors:
      - name: Carlos Vivar Rios
        orcid: "https://orcid.org/0000-0002-8076-2034"
    tool-version: v0.1.0
    tool-repository:
      url: "https://github.com/odtp-org/tool-example"
      doi: null
    tool-license: AGPL-3.0

# If your tool require some secrets token to be passed as ENV to the component
# This won't be traced in MongoDB
secrets: null

# If the tool requires some building arguments such as Matlab license
build-args: null

# If applicable, ports exposed by the component
# Include Name, Description, and Port Value for each port
ports: null

# If applicable, parameters exposed by the component
# Datatype can be str, int, float, or bool.
parameters:
  - name: HF_DATASET
    default-value: "rotten_tomatoes"
    datatype: string
    description: "Hugging face dataset ID"
    options:
      - "rotten_tomatoes"
    allow-custom-value: true

# If applicable, data-input list required by the component
data-inputs: null

# If applicable, data-output list produced by the component
data-output:
  - name: test.csv
    type: csv
    path: "{{HF_DATASET}}/test.csv"
    description: Output from dataset
  - name: train.csv
    type: csv
    path: "{{HF_DATASET}}/train.csv"
    description: Output from dataset
  - name: validation.csv
    type: csv
    path: "{{HF_DATASET}}/validation.csv"
    description: Output from dataset


# If applicable, path to schemas to perform semantic validation.
# Still under development. Ignore.
schema-input: null
schema-output: null

# If applicable, define devices needed such as GPU.
devices:
  - type: gpu
    required: false