Simulai file
File IO #
load_pkl #
Load a pickle file into a Python object.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
path |
str
|
(Default value = None) |
None
|
Returns:
Type | Description |
---|---|
Union[object, None]
|
object or None: |
Raises:
Type | Description |
---|---|
Exception
|
if the provided path is not a file or cannot be opened |
Source code in simulai/file.py
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 |
|
SPFile #
Source code in simulai/file.py
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 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 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 |
|
__init__(compact=False)
#
Class for handling persistence of Pytorch Module-like objects.
SimulAI Persistency File It saves PyTorch Module-like objects in a directory containing the model template and its coefficients dictionary
Parameters:
Name | Type | Description | Default |
---|---|---|---|
compact |
bool
|
Compress the directory to a tar file or not. Default : False |
False
|
Source code in simulai/file.py
65 66 67 68 69 70 71 72 73 74 75 76 |
|
read(model_path=None, device=None, template_name=None)
#
Reads a model from the specified file path, imports it as a module, and initializes it as an object of the corresponding class.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
model_path |
str
|
Complete path to the model. (Default value = None) |
None
|
device |
str
|
Device to load the model onto. (Default value = None) |
None
|
template_name |
str
|
(Default value = None) |
None
|
Returns:
Name | Type | Description |
---|---|---|
NetworkTemplate |
child of torch.nn.Module
|
The model restored to memory. |
Source code in simulai/file.py
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 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 |
|
write(save_dir=None, name=None, template=None, args=None, model=None, device=None)
#
Writes the model and its instantiating function to a directory.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
save_dir |
str
|
The absolute directory path to save the model (Default value = None) |
None
|
name |
str
|
A name for the model. (Default value = None) |
None
|
template |
callable
|
A function for instantiating the model. (Default value = None) |
None
|
args |
dict
|
Dictionary containing arguments to be passed to template. (Default value = None) |
None
|
model |
NetworkTemplate
|
The model to be saved. (Default value = None) |
None
|
device |
str
|
(Default value = None) |
None
|
Source code in simulai/file.py
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 |
|