Skip to content

Commit 896da15

Browse files
committed
Regeenrated nml branch
1 parent 86c7af4 commit 896da15

File tree

11 files changed

+22
-21
lines changed

11 files changed

+22
-21
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ For guidelines on contributing to the development of MDF, see [here](https://git
8686
## Examples
8787

8888
To get started, follow the simple example in a Jupyter notebook [here](https://github.com/ModECI/MDF/blob/main/examples/SimpleExample.ipynb)
89-
89+
9090

9191
Multiple examples of serialized MDF files, the Python scripts used to generate them, as well as mappings to target environments can be found [here](https://github.com/ModECI/MDF/blob/main/examples/README.md).
9292

docs/MDF_specification.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@
107107
"description": "The unique (for this Node) id of the input port,"
108108
},
109109
"default_value": {
110-
"type": "Union[EvaluableExpression, List, Dict, ndarray, int, float, str, NoneType]",
110+
"type": "Union",
111111
"description": "Value to set at this input port if no edge connected to it."
112112
},
113113
"shape": {
@@ -119,7 +119,7 @@
119119
"description": "The data type of the input received at a port."
120120
},
121121
"reduce": {
122-
"type": "Union[str, NoneType]",
122+
"type": "Optional",
123123
"description": "Specifies how to deal with multiple inputs to one port during a single timestep: add: add up all the values; multiply: multiply the values, overwrite: just use the last value supplied (default)"
124124
}
125125
}

docs/MDF_specification.yaml

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,8 +92,7 @@ specification:
9292
type: str
9393
description: The unique (for this Node) id of the input port,
9494
default_value:
95-
type: Union[EvaluableExpression, List, Dict, ndarray, int, float,
96-
str, NoneType]
95+
type: Union
9796
description: Value to set at this input port if no edge connected
9897
to it.
9998
shape:
@@ -107,7 +106,7 @@ specification:
107106
type: Optional
108107
description: The data type of the input received at a port.
109108
reduce:
110-
type: Union[str, NoneType]
109+
type: Optional
111110
description: 'Specifies how to deal with multiple inputs to one port
112111
during a single timestep: add: add up all the values; multiply:
113112
multiply the values, overwrite: just use the last value supplied

docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ The <a href="#inputport">InputPort</a> is an attribute of a Node which allows ex
181181

182182
<tr>
183183
<td><b>default_value</b></td>
184-
<td>Union[EvaluableExpression, List, Dict, ndarray, int, float, str, NoneType]</td>
184+
<td>Union</td>
185185
<td><i>Value to set at this input port if no edge connected to it.</i></td>
186186
</tr>
187187

@@ -203,7 +203,7 @@ The <a href="#inputport">InputPort</a> is an attribute of a Node which allows ex
203203

204204
<tr>
205205
<td><b>reduce</b></td>
206-
<td>Union[str, NoneType]</td>
206+
<td>Optional</td>
207207
<td><i>Specifies how to deal with multiple inputs to one port during a single timestep: add: add up all the values; multiply: multiply the values, overwrite: just use the last value supplied (default)</i></td>
208208
</tr>
209209

docs/sphinx/source/api/Specification.rst

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -87,15 +87,17 @@ The `InputPort <#inputport>`__ is an attribute of a Node which allows external i
8787

8888
**Allowed parameters**
8989

90-
=============== =========== =============================================================================================
91-
Allowed field Data Type Description
92-
=============== =========== =============================================================================================
93-
**metadata** Optional Optional metadata field, an arbitrary dictionary of string keys and JSON serializable values.
94-
**id** str The unique (for this Node) id of the input port,
95-
**shape** Optional The shape of the input port. This uses the same syntax as numpy ndarray shapes
96-
(e.g., **numpy.zeros(shape)** would produce an array with the correct shape
97-
**type** Optional The data type of the input received at a port.
98-
=============== =========== =============================================================================================
90+
================= =========== =================================================================================================================================================================================================
91+
Allowed field Data Type Description
92+
================= =========== =================================================================================================================================================================================================
93+
**metadata** Optional Optional metadata field, an arbitrary dictionary of string keys and JSON serializable values.
94+
**id** str The unique (for this Node) id of the input port,
95+
**default_value** Union Value to set at this input port if no edge connected to it.
96+
**shape** Optional The shape of the input port. This uses the same syntax as numpy ndarray shapes
97+
(e.g., **numpy.zeros(shape)** would produce an array with the correct shape
98+
**type** Optional The data type of the input received at a port.
99+
**reduce** Optional Specifies how to deal with multiple inputs to one port during a single timestep: add: add up all the values; multiply: multiply the values, overwrite: just use the last value supplied (default)
100+
================= =========== =================================================================================================================================================================================================
99101

100102
========
101103
Function

examples/MDF/RNN/IAF_net3.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"IAF_net3": {
33
"format": "ModECI MDF v0.4",
4-
"generating_application": "Python modeci-mdf v0.4.12",
4+
"generating_application": "Python modeci-mdf v0.4.13",
55
"graphs": {
66
"iaf_example": {
77
"nodes": {

examples/MDF/RNN/IAF_net3.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
IAF_net3:
22
format: ModECI MDF v0.4
3-
generating_application: Python modeci-mdf v0.4.12
3+
generating_application: Python modeci-mdf v0.4.13
44
graphs:
55
iaf_example:
66
nodes:

examples/MDF/RNN/IaF.net3.run.png

0 Bytes
Loading

examples/MDF/RNN/RNN.run.png

0 Bytes
Loading

examples/MDF/networks/Net_acyclical.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"Net_acyclical": {
33
"format": "ModECI MDF v0.4",
4-
"generating_application": "Python modeci-mdf v0.4.12",
4+
"generating_application": "Python modeci-mdf v0.4.13",
55
"graphs": {
66
"Net_acyclical": {
77
"nodes": {

0 commit comments

Comments
 (0)