Utils¶
This module provides utility functions for the project.
Functions¶
get_num_scenarios¶
Get total number of scenarios from data directory.
Reads from n_scenarios.txt metadata file in the data directory.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
data_dir
|
str
|
Directory containing parquet files and n_scenarios.txt |
required |
Returns:
| Type | Description |
|---|---|
int
|
Total number of scenarios |
Raises:
| Type | Description |
|---|---|
ValueError
|
If n_scenarios.txt metadata file not found |
Source code in gridfm_datakit/utils/utils.py
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 | |
read_partitions¶
Read sampled partition folders in parallel and concatenate them.
Source code in gridfm_datakit/utils/utils.py
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 | |
write_ram_usage_distributed¶
Source code in gridfm_datakit/utils/utils.py
112 113 114 115 116 117 118 119 120 121 122 123 | |
Classes¶
Tee¶
Source code in gridfm_datakit/utils/utils.py
126 127 128 129 130 131 132 133 134 135 136 137 | |
Value specs¶
parse_value_spec¶
Parse a config entry into a value spec.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
spec
|
Any
|
A number or a mapping with a |
required |
path
|
str
|
The config path named in every error. |
required |
floor
|
Optional[Floor]
|
A lower bound every value must admit. |
None
|
Returns:
| Name | Type | Description |
|---|---|---|
ValueSpec |
ValueSpec
|
The parsed spec. |
Raises:
| Type | Description |
|---|---|
ValueError
|
If the entry is malformed, a parameter is invalid, or a value
can fail the floor. The message starts with |
Source code in gridfm_datakit/utils/value_spec.py
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 | |
ValueSpec¶
A value drawn once per use.
Source code in gridfm_datakit/utils/value_spec.py
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 | |
sample(rng)
¶Draw one value.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
rng
|
Generator
|
The generator every draw comes from. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
Any |
Any
|
A float for numeric specs, the list element for a choice. |
Source code in gridfm_datakit/utils/value_spec.py
73 74 75 76 77 78 79 80 81 82 | |
support()
¶Return the smallest and largest value a draw can take.
Returns:
| Type | Description |
|---|---|
Tuple[Any, Any]
|
Tuple[Any, Any]: The worst case bounds. |
Source code in gridfm_datakit/utils/value_spec.py
84 85 86 87 88 89 90 | |
Floor¶
Lower bound every drawn value must admit.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
bound
|
float
|
The bound. |
required |
strict
|
bool
|
Whether the bound itself is excluded. |
required |
Source code in gridfm_datakit/utils/value_spec.py
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 | |
admits(x)
¶Check a value against the floor.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
x
|
float
|
The value. |
required |
Returns:
| Name | Type | Description |
|---|---|---|
bool |
bool
|
Whether |
Source code in gridfm_datakit/utils/value_spec.py
54 55 56 57 58 59 60 61 62 63 | |