Skip to content

Commit 60f3911

Browse files
caviricaviri
committed
Updated odtp.yml and odtp-component-client
1 parent 6fec312 commit 60f3911

File tree

5 files changed

+132
-80
lines changed

5 files changed

+132
-80
lines changed

‎Dockerfile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ RUN apt-get update && apt-get -y upgrade \
2727
# ODTP setup
2828
##################################################
2929

30-
COPY odtp.requirements.txt /tmp/odtp.requirements.txt
30+
COPY odtp-component-client/requirements.txt /tmp/odtp.requirements.txt
3131
RUN pip install -r /tmp/odtp.requirements.txt
3232

3333

‎README.md‎

Lines changed: 70 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -99,54 +99,84 @@ ODTP requires a set of metadata to work. These fields should be filled by the de
9999

100100
```yml
101101
# This file should contain basic component information for your component.
102-
- component-name: Component Name
103-
- component-author: Component Author
104-
- component-version: Component Version
105-
- component-repository: Component Repository
106-
- component-license: Component License
107-
- component-type: ephemeral or interactive.
108-
- component-description: Description
109-
- tags:
102+
component-name: Component Name
103+
component-author: Component Author
104+
component-version: Component Version
105+
component-repository: Component Repository
106+
component-license: Component License
107+
component-type: ephemeral or interactive
108+
component-description: Description
109+
tags:
110110
- tag1
111111
- tag2
112112

113113
# Information about the tool
114-
- tool-name: Tool name
115-
- tool-author: Tool's author
116-
- tool-version: Tool version
117-
- tool-repository: Tool's repository
118-
- tool-license: Tool's license
119-
120-
# If aplicable, ports exposed by the component
121-
- ports:
122-
- XXXX
123-
124-
# If aplicable, parameters exposed by the component
125-
# Add compatible datatype: str, int or float
126-
- parameters:
127-
- PARAMETER A: datatype
128-
129-
# If aplicable, data-input list required by the component
130-
- data-inputs:
131-
- data
132-
- cache
133-
134-
# If aplicable, data-output list produced by the component
135-
- data-output:
136-
- output
137-
138-
# If aplicable, path to schemas to perform semantic validation.
139-
# Still under development. Ignore.
140-
- schema-input: PATH_TO_INPUT_SCHEMA
141-
- schema-output: PATH_TO_OUTPUT_SCHEMA
142-
143-
# If aplicable, define devices needed such as gpus.
144-
- devices:
145-
- gpus: False
114+
tool-name: Tool name
115+
tool-author: Tool's author
116+
tool-version: Tool version
117+
tool-repository: Tool's repository
118+
tool-license: Tool's license
119+
120+
# If applicable, ports exposed by the component
121+
# Include Name, Description, and Port Value for each port
122+
ports:
123+
- name: PORT A
124+
description: Description of Port A
125+
port-value: XXXX
126+
- name: PORT B
127+
description: Description of Port B
128+
port-value: YYYY
129+
130+
# If applicable, parameters exposed by the component
131+
# Datatype can be str, int, float, or bool.
132+
parameters:
133+
- name: PARAMETER A
134+
default-value: DEFAULT_VALUE_A
135+
datatype: DATATYPE_A
136+
description: Description of Parameter A
137+
- name: PARAMETER B
138+
default-value: DEFAULT_VALUE_B
139+
datatype: DATATYPE_B
140+
description: Description of Parameter B
141+
142+
# If applicable, data-input list required by the component
143+
data-inputs:
144+
- name: INPUT A
145+
type: TYPE_A # Folder or filetype
146+
path: VALUE_A
147+
description: Description of Input A
148+
- name: INPUT B
149+
type: TYPE_B # Folder or filetype
150+
path: VALUE_B
151+
description: Description of Input B
152+
153+
# If applicable, data-output list produced by the component
154+
data-output:
155+
- name: OUTPUT A
156+
type: TYPE_A # Folder or filetype
157+
path: VALUE_A
158+
description: Description of Output A
159+
- name: OUTPUT B
160+
type: TYPE_B # Folder or filetype
161+
path: VALUE_B
162+
description: Description of Output B
163+
164+
# If applicable, path to schemas to perform semantic validation.
165+
# Still under development. Ignore.
166+
schema-input: PATH_TO_INPUT_SCHEMA
167+
schema-output: PATH_TO_OUTPUT_SCHEMA
168+
169+
# If applicable, define devices needed such as GPU.
170+
devices:
171+
gpu: false
146172
```
147173
148174
## Changelog
149175
176+
- v0.3.2
177+
- Extended `odtp.yml` parameters and input/output definition.
178+
- `odtp.requirements.txt` transfered to submodule `odtp-component-client`.
179+
150180
- v0.3.1
151181
- Updating schema fields in `odtp.yml` to kebab-case.
152182

‎odtp-component-client‎

‎odtp.requirements.txt‎

Lines changed: 0 additions & 3 deletions
This file was deleted.

‎odtp.yml‎

Lines changed: 60 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,71 @@
11
# This file should contain basic component information for your component.
2-
- component-name: Component Name
3-
- component-author: Component Author
4-
- component-version: Component Version
5-
- component-repository: Component Repository
6-
- component-license: Component License
7-
- component-type: ephemeral or interactive.
8-
- component-description: Description
9-
- tags:
2+
component-name: Component Name
3+
component-author: Component Author
4+
component-version: Component Version
5+
component-repository: Component Repository
6+
component-license: Component License
7+
component-type: ephemeral or interactive
8+
component-description: Description
9+
tags:
1010
- tag1
1111
- tag2
1212

1313
# Information about the tool
14-
- tool-name: Tool name
15-
- tool-author: Tool's author
16-
- tool-version: Tool version
17-
- tool-repository: Tool's repository
18-
- tool-license: Tool's license
14+
tool-name: Tool name
15+
tool-author: Tool's author
16+
tool-version: Tool version
17+
tool-repository: Tool's repository
18+
tool-license: Tool's license
1919

20-
# If aplicable, ports exposed by the component
21-
- ports:
22-
- XXXX
20+
# If applicable, ports exposed by the component
21+
# Include Name, Description, and Port Value for each port
22+
ports:
23+
- name: PORT A
24+
description: Description of Port A
25+
port-value: XXXX
26+
- name: PORT B
27+
description: Description of Port B
28+
port-value: YYYY
2329

24-
# If aplicable, parameters exposed by the component
25-
# Add compatible datatype: str, int or float
26-
- parameters:
27-
- PARAMETER A: datatype
30+
# If applicable, parameters exposed by the component
31+
# Datatype can be str, int, float, or bool.
32+
parameters:
33+
- name: PARAMETER A
34+
default-value: DEFAULT_VALUE_A
35+
datatype: DATATYPE_A
36+
description: Description of Parameter A
37+
- name: PARAMETER B
38+
default-value: DEFAULT_VALUE_B
39+
datatype: DATATYPE_B
40+
description: Description of Parameter B
2841

29-
# If aplicable, data-input list required by the component
30-
- data-inputs:
31-
- data
32-
- cache
42+
# If applicable, data-input list required by the component
43+
data-inputs:
44+
- name: INPUT A
45+
type: TYPE_A # Folder or filetype
46+
path: VALUE_A
47+
description: Description of Input A
48+
- name: INPUT B
49+
type: TYPE_B # Folder or filetype
50+
path: VALUE_B
51+
description: Description of Input B
3352

34-
# If aplicable, data-output list produced by the component
35-
- data-output:
36-
- output
53+
# If applicable, data-output list produced by the component
54+
data-output:
55+
- name: OUTPUT A
56+
type: TYPE_A # Folder or filetype
57+
path: VALUE_A
58+
description: Description of Output A
59+
- name: OUTPUT B
60+
type: TYPE_B # Folder or filetype
61+
path: VALUE_B
62+
description: Description of Output B
3763

38-
# If aplicable, path to schemas to perform semantic validation.
39-
# Still under development. Ignore.
40-
- schema-input: PATH_TO_INPUT_SCHEMA
41-
- schema-output: PATH_TO_OUTPUT_SCHEMA
42-
43-
# If aplicable, define devices needed such as gpus.
44-
- devices:
45-
- gpus: False
64+
# If applicable, path to schemas to perform semantic validation.
65+
# Still under development. Ignore.
66+
schema-input: PATH_TO_INPUT_SCHEMA
67+
schema-output: PATH_TO_OUTPUT_SCHEMA
4668

69+
# If applicable, define devices needed such as GPU.
70+
devices:
71+
gpu: false

0 commit comments

Comments
 (0)