mat3ra-esse 2025.8.14.post0__py3-none-any.whl → 2025.8.20.post0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of mat3ra-esse might be problematic. Click here for more details.

Files changed (51) hide show
  1. mat3ra/esse/data/examples.py +1 -1
  2. mat3ra/esse/data/schemas.py +1 -1
  3. mat3ra/esse/models/core/reference/__init__.py +5 -5
  4. mat3ra/esse/models/core/reference/experiment/__init__.py +2 -2
  5. mat3ra/esse/models/job/__init__.py +21 -21
  6. mat3ra/esse/models/material/__init__.py +8 -8
  7. mat3ra/esse/models/materials_category/defective_structures/zero_dimensional/point_defect/interstitial.py +17 -17
  8. mat3ra/esse/models/materials_category/defective_structures/zero_dimensional/point_defect/substitutional.py +17 -17
  9. mat3ra/esse/models/materials_category/defective_structures/zero_dimensional/point_defect/vacancy.py +8 -8
  10. mat3ra/esse/models/materials_category/pristine_structures/three_dimensional/ideal_crystal.py +8 -8
  11. mat3ra/esse/models/materials_category/pristine_structures/two_dimensional/nanoribbon.py +26 -26
  12. mat3ra/esse/models/materials_category/pristine_structures/two_dimensional/nanotape.py +17 -17
  13. mat3ra/esse/models/materials_category/pristine_structures/two_dimensional/slab.py +17 -17
  14. mat3ra/esse/models/materials_category/pristine_structures/two_dimensional/slab_strained_supercell.py +17 -17
  15. mat3ra/esse/models/materials_category_components/entities/auxiliary/zero_dimensional/point_defect_site.py +8 -8
  16. mat3ra/esse/models/materials_category_components/entities/auxiliary/zero_dimensional/void_region.py +8 -8
  17. mat3ra/esse/models/materials_category_components/entities/core/two_dimensional/vacuum.py +8 -8
  18. mat3ra/esse/models/materials_category_components/entities/reusable/three_dimensional/strained_non_uniform.py +8 -8
  19. mat3ra/esse/models/materials_category_components/entities/reusable/three_dimensional/strained_uniform.py +8 -8
  20. mat3ra/esse/models/materials_category_components/entities/reusable/three_dimensional/supercell.py +8 -8
  21. mat3ra/esse/models/materials_category_components/entities/reusable/two_dimensional/slab_stack_configuration.py +26 -26
  22. mat3ra/esse/models/materials_category_components/operations/core/modifications/perturb.py +8 -8
  23. mat3ra/esse/models/properties_directory/non_scalar/total_energy_contributions.py +26 -26
  24. mat3ra/esse/models/properties_directory/structural/molecular_pattern.py +4 -4
  25. mat3ra/esse/models/property/meta.py +2 -2
  26. mat3ra/esse/models/property/raw.py +2 -2
  27. mat3ra/esse/models/property/source.py +2 -2
  28. mat3ra/esse/models/workflow/__init__.py +19 -19
  29. mat3ra/esse/models/workflow/subworkflow/__init__.py +6 -6
  30. mat3ra/esse/models/workflow/subworkflow/unit.py +6 -6
  31. mat3ra/esse/models/workflow/unit/__init__.py +8 -8
  32. {mat3ra_esse-2025.8.14.post0.dist-info → mat3ra_esse-2025.8.20.post0.dist-info}/METADATA +1 -1
  33. {mat3ra_esse-2025.8.14.post0.dist-info → mat3ra_esse-2025.8.20.post0.dist-info}/RECORD +36 -51
  34. mat3ra/esse/models/software_directory/ml/__init__.py +0 -3
  35. mat3ra/esse/models/software_directory/ml/exabyteml.py +0 -28
  36. mat3ra/esse/models/software_directory/ml/unit/__init__.py +0 -3
  37. mat3ra/esse/models/software_directory/ml/unit/execution/__init__.py +0 -879
  38. mat3ra/esse/models/software_directory/ml/unit/execution/evaluate/__init__.py +0 -3
  39. mat3ra/esse/models/software_directory/ml/unit/execution/evaluate/cross_validate.py +0 -293
  40. mat3ra/esse/models/software_directory/ml/unit/execution/initialize.py +0 -293
  41. mat3ra/esse/models/software_directory/ml/unit/execution/score.py +0 -286
  42. mat3ra/esse/models/software_directory/ml/unit/execution/train.py +0 -297
  43. mat3ra/esse/models/software_directory/ml/unit/processing/__init__.py +0 -276
  44. mat3ra/esse/models/software_directory/ml/unit/processing/data_transformation/__init__.py +0 -167
  45. mat3ra/esse/models/software_directory/ml/unit/processing/data_transformation/manipulation.py +0 -144
  46. mat3ra/esse/models/software_directory/ml/unit/processing/data_transformation/scale_and_reduce.py +0 -163
  47. mat3ra/esse/models/software_directory/ml/unit/processing/feature_selection/__init__.py +0 -148
  48. mat3ra/esse/models/software_directory/ml/unit/processing/feature_selection/filter_based.py +0 -144
  49. {mat3ra_esse-2025.8.14.post0.dist-info → mat3ra_esse-2025.8.20.post0.dist-info}/WHEEL +0 -0
  50. {mat3ra_esse-2025.8.14.post0.dist-info → mat3ra_esse-2025.8.20.post0.dist-info}/licenses/LICENSE.md +0 -0
  51. {mat3ra_esse-2025.8.14.post0.dist-info → mat3ra_esse-2025.8.20.post0.dist-info}/top_level.txt +0 -0
@@ -1,276 +0,0 @@
1
- # generated by datamodel-codegen:
2
- # filename: software_directory/ml/unit/processing.json
3
- # version: 0.28.5
4
-
5
- from __future__ import annotations
6
-
7
- from enum import Enum
8
- from typing import Any, Dict, List, Optional, Union
9
-
10
- from pydantic import BaseModel, ConfigDict, Field, RootModel
11
-
12
-
13
- class Operation(Enum):
14
- data_transformation = "data_transformation"
15
-
16
-
17
- class OperationType(Enum):
18
- scale_and_reduce = "scale_and_reduce"
19
-
20
-
21
- class Scaler(Enum):
22
- standard_scaler = "standard_scaler"
23
-
24
-
25
- class PerFeatureItem(BaseModel):
26
- variance: Optional[float] = None
27
- """
28
- variance in original training data
29
- """
30
- mean: Optional[float] = None
31
- """
32
- mean value of the original training data
33
- """
34
- scale: float
35
- """
36
- scale multiplier for this feature/property
37
- """
38
- name: str
39
- """
40
- feature/property name in 'flattened' format
41
- """
42
-
43
-
44
- class InputData(BaseModel):
45
- scaler: Optional[Scaler] = "standard_scaler"
46
- """
47
- type of scaler to be applied
48
- """
49
- perFeature: Optional[List[PerFeatureItem]] = None
50
- """
51
- per-feature scaling data
52
- """
53
-
54
-
55
- class Type(Enum):
56
- processing = "processing"
57
-
58
-
59
- class Status(Enum):
60
- idle = "idle"
61
- active = "active"
62
- warning = "warning"
63
- error = "error"
64
- finished = "finished"
65
-
66
-
67
- class NameResultSchema(BaseModel):
68
- name: str
69
- """
70
- The name of this item. e.g. scf_accuracy
71
- """
72
-
73
-
74
- class StatusTrackItem(BaseModel):
75
- trackedAt: float
76
- status: str
77
- repetition: Optional[float] = None
78
-
79
-
80
- class ScaleAndReduceUnitSchema(BaseModel):
81
- model_config = ConfigDict(
82
- extra="allow",
83
- )
84
- operation: Operation
85
- """
86
- Contains information about the operation used.
87
- """
88
- operationType: OperationType
89
- """
90
- Contains information about the specific type of the operation used.
91
- """
92
- inputData: InputData
93
- """
94
- unit input (type to be specified by the child units)
95
- """
96
- type: Type
97
- """
98
- type of the unit
99
- """
100
- field_id: Optional[str] = Field(None, alias="_id")
101
- """
102
- entity identity
103
- """
104
- isDraft: Optional[bool] = None
105
- name: Optional[str] = None
106
- """
107
- name of the unit. e.g. pw_scf
108
- """
109
- status: Optional[Status] = None
110
- """
111
- Status of the unit.
112
- """
113
- head: Optional[bool] = None
114
- """
115
- Whether this unit is the first one to be executed.
116
- """
117
- flowchartId: str
118
- """
119
- Identity of the unit in the workflow. Used to trace the execution flow of the workflow.
120
- """
121
- next: Optional[str] = None
122
- """
123
- Next unit's flowchartId. If empty, the current unit is the last.
124
- """
125
- enableRender: Optional[bool] = None
126
- """
127
- Whether Rupy should attempt to use Jinja templating to add context variables into the unit
128
- """
129
- context: Optional[Dict[str, Any]] = None
130
- slug: Optional[str] = None
131
- """
132
- entity slug
133
- """
134
- systemName: Optional[str] = None
135
- schemaVersion: Optional[str] = "2022.8.16"
136
- """
137
- entity's schema version. Used to distinct between different schemas.
138
- """
139
- isDefault: Optional[bool] = False
140
- """
141
- Identifies that entity is defaultable
142
- """
143
- preProcessors: Optional[List[Union[NameResultSchema, str]]] = None
144
- """
145
- names of the pre-processors for this calculation
146
- """
147
- postProcessors: Optional[List[Union[NameResultSchema, str]]] = None
148
- """
149
- names of the post-processors for this calculation
150
- """
151
- monitors: Optional[List[Union[NameResultSchema, str]]] = None
152
- """
153
- names of the monitors for this calculation
154
- """
155
- results: Optional[List[Union[NameResultSchema, str]]] = None
156
- """
157
- names of the results for this calculation
158
- """
159
- tags: Optional[List[str]] = None
160
- """
161
- entity tags
162
- """
163
- statusTrack: Optional[List[StatusTrackItem]] = None
164
-
165
-
166
- class Operation5(Enum):
167
- feature_selection = "feature_selection"
168
-
169
-
170
- class OperationType5(Enum):
171
- filter_based = "filter_based"
172
-
173
-
174
- class Algorithm(Enum):
175
- f_regression = "f_regression"
176
-
177
-
178
- class InputData5(BaseModel):
179
- nFeatures: float
180
- """
181
- number of features to select for model training. If equal to 0, will use all available features
182
- """
183
- algorithm: Algorithm
184
- """
185
- feature selection algorithm following sklearn.feature_selection
186
- """
187
-
188
-
189
- class FilterBasedFeatureSelectionUnitSchema(BaseModel):
190
- model_config = ConfigDict(
191
- extra="allow",
192
- )
193
- operation: Operation5
194
- """
195
- Contains information about the operation used.
196
- """
197
- operationType: OperationType5
198
- """
199
- Contains information about the specific type of the operation used.
200
- """
201
- inputData: InputData5
202
- """
203
- unit input (type to be specified by the child units)
204
- """
205
- type: Type
206
- """
207
- type of the unit
208
- """
209
- field_id: Optional[str] = Field(None, alias="_id")
210
- """
211
- entity identity
212
- """
213
- isDraft: Optional[bool] = None
214
- name: Optional[str] = None
215
- """
216
- name of the unit. e.g. pw_scf
217
- """
218
- status: Optional[Status] = None
219
- """
220
- Status of the unit.
221
- """
222
- head: Optional[bool] = None
223
- """
224
- Whether this unit is the first one to be executed.
225
- """
226
- flowchartId: str
227
- """
228
- Identity of the unit in the workflow. Used to trace the execution flow of the workflow.
229
- """
230
- next: Optional[str] = None
231
- """
232
- Next unit's flowchartId. If empty, the current unit is the last.
233
- """
234
- enableRender: Optional[bool] = None
235
- """
236
- Whether Rupy should attempt to use Jinja templating to add context variables into the unit
237
- """
238
- context: Optional[Dict[str, Any]] = None
239
- slug: Optional[str] = None
240
- """
241
- entity slug
242
- """
243
- systemName: Optional[str] = None
244
- schemaVersion: Optional[str] = "2022.8.16"
245
- """
246
- entity's schema version. Used to distinct between different schemas.
247
- """
248
- isDefault: Optional[bool] = False
249
- """
250
- Identifies that entity is defaultable
251
- """
252
- preProcessors: Optional[List[Union[NameResultSchema, str]]] = None
253
- """
254
- names of the pre-processors for this calculation
255
- """
256
- postProcessors: Optional[List[Union[NameResultSchema, str]]] = None
257
- """
258
- names of the post-processors for this calculation
259
- """
260
- monitors: Optional[List[Union[NameResultSchema, str]]] = None
261
- """
262
- names of the monitors for this calculation
263
- """
264
- results: Optional[List[Union[NameResultSchema, str]]] = None
265
- """
266
- names of the results for this calculation
267
- """
268
- tags: Optional[List[str]] = None
269
- """
270
- entity tags
271
- """
272
- statusTrack: Optional[List[StatusTrackItem]] = None
273
-
274
-
275
- class ESSE(RootModel[Union[ScaleAndReduceUnitSchema, FilterBasedFeatureSelectionUnitSchema]]):
276
- root: Union[ScaleAndReduceUnitSchema, FilterBasedFeatureSelectionUnitSchema]
@@ -1,167 +0,0 @@
1
- # generated by datamodel-codegen:
2
- # filename: software_directory/ml/unit/processing/data_transformation.json
3
- # version: 0.28.5
4
-
5
- from __future__ import annotations
6
-
7
- from enum import Enum
8
- from typing import Any, Dict, List, Optional, Union
9
-
10
- from pydantic import BaseModel, ConfigDict, Field, RootModel
11
-
12
-
13
- class Operation(Enum):
14
- data_transformation = "data_transformation"
15
-
16
-
17
- class OperationType(Enum):
18
- scale_and_reduce = "scale_and_reduce"
19
-
20
-
21
- class Scaler(Enum):
22
- standard_scaler = "standard_scaler"
23
-
24
-
25
- class PerFeatureItem(BaseModel):
26
- variance: Optional[float] = None
27
- """
28
- variance in original training data
29
- """
30
- mean: Optional[float] = None
31
- """
32
- mean value of the original training data
33
- """
34
- scale: float
35
- """
36
- scale multiplier for this feature/property
37
- """
38
- name: str
39
- """
40
- feature/property name in 'flattened' format
41
- """
42
-
43
-
44
- class InputData(BaseModel):
45
- scaler: Optional[Scaler] = "standard_scaler"
46
- """
47
- type of scaler to be applied
48
- """
49
- perFeature: Optional[List[PerFeatureItem]] = None
50
- """
51
- per-feature scaling data
52
- """
53
-
54
-
55
- class Type(Enum):
56
- processing = "processing"
57
-
58
-
59
- class Status(Enum):
60
- idle = "idle"
61
- active = "active"
62
- warning = "warning"
63
- error = "error"
64
- finished = "finished"
65
-
66
-
67
- class NameResultSchema(BaseModel):
68
- name: str
69
- """
70
- The name of this item. e.g. scf_accuracy
71
- """
72
-
73
-
74
- class StatusTrackItem(BaseModel):
75
- trackedAt: float
76
- status: str
77
- repetition: Optional[float] = None
78
-
79
-
80
- class ScaleAndReduceUnitSchema(BaseModel):
81
- model_config = ConfigDict(
82
- extra="allow",
83
- )
84
- operation: Operation
85
- """
86
- Contains information about the operation used.
87
- """
88
- operationType: OperationType
89
- """
90
- Contains information about the specific type of the operation used.
91
- """
92
- inputData: InputData
93
- """
94
- unit input (type to be specified by the child units)
95
- """
96
- type: Type
97
- """
98
- type of the unit
99
- """
100
- field_id: Optional[str] = Field(None, alias="_id")
101
- """
102
- entity identity
103
- """
104
- isDraft: Optional[bool] = None
105
- name: Optional[str] = None
106
- """
107
- name of the unit. e.g. pw_scf
108
- """
109
- status: Optional[Status] = None
110
- """
111
- Status of the unit.
112
- """
113
- head: Optional[bool] = None
114
- """
115
- Whether this unit is the first one to be executed.
116
- """
117
- flowchartId: str
118
- """
119
- Identity of the unit in the workflow. Used to trace the execution flow of the workflow.
120
- """
121
- next: Optional[str] = None
122
- """
123
- Next unit's flowchartId. If empty, the current unit is the last.
124
- """
125
- enableRender: Optional[bool] = None
126
- """
127
- Whether Rupy should attempt to use Jinja templating to add context variables into the unit
128
- """
129
- context: Optional[Dict[str, Any]] = None
130
- slug: Optional[str] = None
131
- """
132
- entity slug
133
- """
134
- systemName: Optional[str] = None
135
- schemaVersion: Optional[str] = "2022.8.16"
136
- """
137
- entity's schema version. Used to distinct between different schemas.
138
- """
139
- isDefault: Optional[bool] = False
140
- """
141
- Identifies that entity is defaultable
142
- """
143
- preProcessors: Optional[List[Union[NameResultSchema, str]]] = None
144
- """
145
- names of the pre-processors for this calculation
146
- """
147
- postProcessors: Optional[List[Union[NameResultSchema, str]]] = None
148
- """
149
- names of the post-processors for this calculation
150
- """
151
- monitors: Optional[List[Union[NameResultSchema, str]]] = None
152
- """
153
- names of the monitors for this calculation
154
- """
155
- results: Optional[List[Union[NameResultSchema, str]]] = None
156
- """
157
- names of the results for this calculation
158
- """
159
- tags: Optional[List[str]] = None
160
- """
161
- entity tags
162
- """
163
- statusTrack: Optional[List[StatusTrackItem]] = None
164
-
165
-
166
- class ESSE(RootModel[ScaleAndReduceUnitSchema]):
167
- root: ScaleAndReduceUnitSchema
@@ -1,144 +0,0 @@
1
- # generated by datamodel-codegen:
2
- # filename: software_directory/ml/unit/processing/data_transformation/manipulation.json
3
- # version: 0.28.5
4
-
5
- from __future__ import annotations
6
-
7
- from enum import Enum
8
- from typing import Any, Dict, List, Optional, Union
9
-
10
- from pydantic import BaseModel, ConfigDict, Field
11
-
12
-
13
- class Operation(Enum):
14
- data_transformation = "data_transformation"
15
-
16
-
17
- class OperationType(Enum):
18
- manipulation = "manipulation"
19
-
20
-
21
- class InputData(BaseModel):
22
- cleanMissingData: Optional[bool] = True
23
- """
24
- whether to clean missing data, eg. NaN
25
- """
26
- removeDuplicateRows: Optional[bool] = True
27
- """
28
- whether to remove duplicate rows
29
- """
30
- replaceNoneValuesWith: Optional[float] = 0
31
- """
32
- replace None values with a given value
33
- """
34
-
35
-
36
- class Type(Enum):
37
- processing = "processing"
38
-
39
-
40
- class Status(Enum):
41
- idle = "idle"
42
- active = "active"
43
- warning = "warning"
44
- error = "error"
45
- finished = "finished"
46
-
47
-
48
- class NameResultSchema(BaseModel):
49
- name: str
50
- """
51
- The name of this item. e.g. scf_accuracy
52
- """
53
-
54
-
55
- class StatusTrackItem(BaseModel):
56
- trackedAt: float
57
- status: str
58
- repetition: Optional[float] = None
59
-
60
-
61
- class ManipulationUnitSchema(BaseModel):
62
- model_config = ConfigDict(
63
- extra="allow",
64
- )
65
- operation: Operation
66
- """
67
- Contains information about the operation used.
68
- """
69
- operationType: OperationType
70
- """
71
- Contains information about the specific type of the operation used.
72
- """
73
- inputData: InputData
74
- """
75
- unit input (type to be specified by the child units)
76
- """
77
- type: Type
78
- """
79
- type of the unit
80
- """
81
- field_id: Optional[str] = Field(None, alias="_id")
82
- """
83
- entity identity
84
- """
85
- isDraft: Optional[bool] = None
86
- name: Optional[str] = None
87
- """
88
- name of the unit. e.g. pw_scf
89
- """
90
- status: Optional[Status] = None
91
- """
92
- Status of the unit.
93
- """
94
- head: Optional[bool] = None
95
- """
96
- Whether this unit is the first one to be executed.
97
- """
98
- flowchartId: str
99
- """
100
- Identity of the unit in the workflow. Used to trace the execution flow of the workflow.
101
- """
102
- next: Optional[str] = None
103
- """
104
- Next unit's flowchartId. If empty, the current unit is the last.
105
- """
106
- enableRender: Optional[bool] = None
107
- """
108
- Whether Rupy should attempt to use Jinja templating to add context variables into the unit
109
- """
110
- context: Optional[Dict[str, Any]] = None
111
- slug: Optional[str] = None
112
- """
113
- entity slug
114
- """
115
- systemName: Optional[str] = None
116
- schemaVersion: Optional[str] = "2022.8.16"
117
- """
118
- entity's schema version. Used to distinct between different schemas.
119
- """
120
- isDefault: Optional[bool] = False
121
- """
122
- Identifies that entity is defaultable
123
- """
124
- preProcessors: Optional[List[Union[NameResultSchema, str]]] = None
125
- """
126
- names of the pre-processors for this calculation
127
- """
128
- postProcessors: Optional[List[Union[NameResultSchema, str]]] = None
129
- """
130
- names of the post-processors for this calculation
131
- """
132
- monitors: Optional[List[Union[NameResultSchema, str]]] = None
133
- """
134
- names of the monitors for this calculation
135
- """
136
- results: Optional[List[Union[NameResultSchema, str]]] = None
137
- """
138
- names of the results for this calculation
139
- """
140
- tags: Optional[List[str]] = None
141
- """
142
- entity tags
143
- """
144
- statusTrack: Optional[List[StatusTrackItem]] = None