|
1 | 1 | # Change log
|
2 | 2 |
|
3 |
| -## [v2.0.0](https://github.com/simvue-io/client/releases/tag/v2.0.0) - 2025-03-07 |
| 3 | +## [v2.0.0](https://github.com/simvue-io/python-api/releases/tag/v2.0.0) - 2025-03-07 |
4 | 4 | * Add new example notebooks
|
5 | 5 | * Update and refactor examples to work with v2.0
|
6 | 6 | * Fix bug in offline artifacts using wrong file path
|
|
51 | 51 | * Adds additional functionality and support for offline mode.
|
52 | 52 | * Support for Simvue servers `>=3`.
|
53 | 53 |
|
54 |
| -## [v1.1.4](https://github.com/simvue-io/client/releases/tag/v1.1.4) - 2024-12-11 |
| 54 | +## [v1.1.4](https://github.com/simvue-io/python-api/releases/tag/v1.1.4) - 2024-12-11 |
55 | 55 |
|
56 | 56 | * Remove incorrect identifier reference for latest Simvue servers during reconnection.
|
57 | 57 | * Fixed missing online mode selection when retrieving configuration for `Client` class.
|
58 | 58 |
|
59 |
| -## [v1.1.3](https://github.com/simvue-io/client/releases/tag/v1.1.3) - 2024-12-09 |
| 59 | +## [v1.1.3](https://github.com/simvue-io/python-api/releases/tag/v1.1.3) - 2024-12-09 |
60 | 60 |
|
61 | 61 | * Fixed bug with `requirements.txt` metadata read.
|
62 | 62 | * Added Simvue server version check.
|
63 | 63 | * Remove checking of server version in offline mode and add default run mode to configuration options.
|
64 | 64 | * Fix offline mode class initialisation, and propagation of configuration.
|
65 | 65 |
|
66 |
| -## [v1.1.2](https://github.com/simvue-io/client/releases/tag/v1.1.2) - 2024-11-06 |
| 66 | +## [v1.1.2](https://github.com/simvue-io/python-api/releases/tag/v1.1.2) - 2024-11-06 |
67 | 67 |
|
68 | 68 | * Fix bug in offline mode directory retrieval.
|
69 | 69 |
|
70 |
| -## [v1.1.1](https://github.com/simvue-io/client/releases/tag/v1.1.1) - 2024-10-22 |
| 70 | +## [v1.1.1](https://github.com/simvue-io/python-api/releases/tag/v1.1.1) - 2024-10-22 |
71 | 71 |
|
72 | 72 | * Add missing `offline.cache` key to TOML config.
|
73 | 73 | * Fix repetition of server URL validation for each call to configuration.
|
74 | 74 |
|
75 |
| -## [v1.1.0](https://github.com/simvue-io/client/releases/tag/v1.1.0) - 2024-10-21 |
| 75 | +## [v1.1.0](https://github.com/simvue-io/python-api/releases/tag/v1.1.0) - 2024-10-21 |
76 | 76 |
|
77 | 77 | * Add option to specify a callback executed when an alert is triggered for a run.
|
78 | 78 | * Allow retrieval of all alerts when no constraints are specified.
|
|
83 | 83 | * Indicate the source used for token and URL.
|
84 | 84 | * Migrate to `simvue.toml` from `simvue.ini`, allowing more defaults to be set during runs.
|
85 | 85 |
|
86 |
| -## [v1.0.6](https://github.com/simvue-io/client/releases/tag/v1.0.6) - 2024-10-10 |
| 86 | +## [v1.0.6](https://github.com/simvue-io/python-api/releases/tag/v1.0.6) - 2024-10-10 |
87 | 87 |
|
88 | 88 | * Fix incorrect usage of `retry` when attempting connections to the server.
|
89 | 89 |
|
90 |
| -## [v1.0.5](https://github.com/simvue-io/client/releases/tag/v1.0.5) - 2024-10-09 |
| 90 | +## [v1.0.5](https://github.com/simvue-io/python-api/releases/tag/v1.0.5) - 2024-10-09 |
91 | 91 |
|
92 | 92 | * Ensure all functionality is deactivated when mode is set to `disabled`.
|
93 | 93 | * When an exception is thrown an event is sent to Simvue displaying the traceback.
|
94 | 94 | * If `add_process` is used and an exception is thrown, `.err` and `.out` files are still uploaded.
|
95 | 95 |
|
96 |
| -## [v1.0.4](https://github.com/simvue-io/client/releases/tag/v1.0.4) - 2024-09-24 |
| 96 | +## [v1.0.4](https://github.com/simvue-io/python-api/releases/tag/v1.0.4) - 2024-09-24 |
97 | 97 |
|
98 | 98 | * Set resource metrics to be recorded by default.
|
99 | 99 |
|
100 |
| -## [v1.0.3](https://github.com/simvue-io/client/releases/tag/v1.0.3) - 2024-09-23 |
| 100 | +## [v1.0.3](https://github.com/simvue-io/python-api/releases/tag/v1.0.3) - 2024-09-23 |
101 | 101 |
|
102 | 102 | * Fix issue of hanging threads when exception raised by script using the API.
|
103 | 103 |
|
104 |
| -## [v1.0.2](https://github.com/simvue-io/client/releases/tag/v1.0.2) - 2024-08-21 |
| 104 | +## [v1.0.2](https://github.com/simvue-io/python-api/releases/tag/v1.0.2) - 2024-08-21 |
105 | 105 |
|
106 | 106 | * Fix incorrect HTTP status code in `Client` when checking if object exists.
|
107 | 107 | * Fix issue with `running=False` when launching a `Run` caused by incorrect system metadata being sent to the server.
|
108 | 108 |
|
109 |
| -## [v1.0.1](https://github.com/simvue-io/client/releases/tag/v1.0.1) - 2024-07-16 |
| 109 | +## [v1.0.1](https://github.com/simvue-io/python-api/releases/tag/v1.0.1) - 2024-07-16 |
110 | 110 |
|
111 | 111 | * Fix to `add_process` with list of strings as arguments, the executable no longer returns the string `"None"`.
|
112 | 112 | * Fix callbacks and triggers for `add_process` being executed only on `Run` class termination, not on process completion.
|
113 | 113 |
|
114 |
| -## [v1.0.0](https://github.com/simvue-io/client/releases/tag/v1.0.0) - 2024-06-14 |
| 114 | +## [v1.0.0](https://github.com/simvue-io/python-api/releases/tag/v1.0.0) - 2024-06-14 |
115 | 115 |
|
116 | 116 | * Refactor and re-write of codebase to align with latest developments in version 2 of the Simvue server.
|
117 | 117 | * Added `Executor` to Simvue runs allowing users to start shell based processes as part of a run and handle termination of these.
|
|
121 | 121 | * Fixed issue whereby metrics would still have to wait for the next iteration of dispatch before being sent to the server, even if the queue was not full.
|
122 | 122 | * Added support for `'user'` alerts.
|
123 | 123 |
|
124 |
| -## [v0.14.3](https://github.com/simvue-io/client/releases/tag/v0.14.3) - 2023-06-29 |
| 124 | +## [v0.14.3](https://github.com/simvue-io/python-api/releases/tag/v0.14.3) - 2023-06-29 |
125 | 125 |
|
126 | 126 | * Ensure import of the `requests` module is only done if actually used.
|
127 | 127 |
|
128 |
| -## [v0.14.0](https://github.com/simvue-io/client/releases/tag/v0.14.0) - 2023-04-04 |
| 128 | +## [v0.14.0](https://github.com/simvue-io/python-api/releases/tag/v0.14.0) - 2023-04-04 |
129 | 129 |
|
130 | 130 | * Added a method to the `Client` class for retrieving events.
|
131 | 131 |
|
132 |
| -## [v0.13.3](https://github.com/simvue-io/client/releases/tag/v0.13.3) - 2023-04-04 |
| 132 | +## [v0.13.3](https://github.com/simvue-io/python-api/releases/tag/v0.13.3) - 2023-04-04 |
133 | 133 |
|
134 | 134 | * Allow files (`input` and `code` only) to be saved for runs in the `created` state.
|
135 | 135 | * Allow metadata and tags to be updated for runs in the `created` state.
|
136 | 136 |
|
137 |
| -## [v0.13.2](https://github.com/simvue-io/client/releases/tag/v0.13.2) - 2023-04-04 |
| 137 | +## [v0.13.2](https://github.com/simvue-io/python-api/releases/tag/v0.13.2) - 2023-04-04 |
138 | 138 |
|
139 | 139 | * Added `plot_metrics` method to the `Client` class to simplify plotting metrics.
|
140 | 140 | * (Bug fix) `reconnect` works without a uuid being specified when `offline` mode isn't being used.
|
141 | 141 | * (Bug fix) Restrict version of Pydantic to prevent v2 from accidentally being used.
|
142 | 142 |
|
143 |
| -## [v0.13.1](https://github.com/simvue-io/client/releases/tag/v0.13.1) - 2023-03-28 |
| 143 | +## [v0.13.1](https://github.com/simvue-io/python-api/releases/tag/v0.13.1) - 2023-03-28 |
144 | 144 |
|
145 | 145 | * Set `sample_by` to 0 by default (no sampling) in `get_metrics_multiple`.
|
146 | 146 |
|
147 |
| -## [v0.13.0](https://github.com/simvue-io/client/releases/tag/v0.13.0) - 2023-03-28 |
| 147 | +## [v0.13.0](https://github.com/simvue-io/python-api/releases/tag/v0.13.0) - 2023-03-28 |
148 | 148 |
|
149 | 149 | * Added methods to the `Client` class for retrieving metrics.
|
150 | 150 | * CPU architecture and processor obtained on Apple hardware.
|
151 | 151 | * Client now reports to server when files have been successfully uploaded.
|
152 | 152 | * `User-Agent` header now included in HTTP requests.
|
153 | 153 |
|
154 |
| -## [v0.12.0](https://github.com/simvue-io/client/releases/tag/v0.12.0) - 2023-03-13 |
| 154 | +## [v0.12.0](https://github.com/simvue-io/python-api/releases/tag/v0.12.0) - 2023-03-13 |
155 | 155 |
|
156 | 156 | * Add methods to the `Client` class for deleting runs and folders.
|
157 | 157 | * Confusing messages about `process no longer exists` or `NVML Shared Library Not Found` no longer displayed.
|
158 | 158 |
|
159 |
| -## [v0.11.4](https://github.com/simvue-io/client/releases/tag/v0.11.4) - 2023-03-13 |
| 159 | +## [v0.11.4](https://github.com/simvue-io/python-api/releases/tag/v0.11.4) - 2023-03-13 |
160 | 160 |
|
161 | 161 | * (Bug fix) Ensure `simvue_sender` can be run when installed from PyPI.
|
162 | 162 | * (Bug fix) Runs created in `offline` mode using a context manager weren't automatically closed.
|
163 | 163 |
|
164 |
| -## [v0.11.3](https://github.com/simvue-io/client/releases/tag/v0.11.3) - 2023-03-07 |
| 164 | +## [v0.11.3](https://github.com/simvue-io/python-api/releases/tag/v0.11.3) - 2023-03-07 |
165 | 165 |
|
166 | 166 | * Added logging messages for debugging when debug level set to `debug`.
|
167 | 167 |
|
168 |
| -## [v0.11.2](https://github.com/simvue-io/client/releases/tag/v0.11.2) - 2023-03-06 |
| 168 | +## [v0.11.2](https://github.com/simvue-io/python-api/releases/tag/v0.11.2) - 2023-03-06 |
169 | 169 |
|
170 | 170 | * Raise exceptions in `Client` class methods if run does not exist or artifact does not exist.
|
171 | 171 | * (Bug fix) `list_artifacts` optional category restriction now works.
|
172 | 172 |
|
173 |
| -## [v0.11.1](https://github.com/simvue-io/client/releases/tag/v0.11.1) - 2023-03-05 |
| 173 | +## [v0.11.1](https://github.com/simvue-io/python-api/releases/tag/v0.11.1) - 2023-03-05 |
174 | 174 |
|
175 | 175 | * Support different runs having different metadata in `get_runs` dataframe output.
|
176 | 176 | * (Bug fix) Error message when creating a duplicate run is now more clear.
|
177 | 177 | * (Bug fix) Correction to stopping the worker thread in situations where the run never started.
|
178 | 178 |
|
179 |
| -## [v0.11.0](https://github.com/simvue-io/client/releases/tag/v0.11.0) - 2023-03-04 |
| 179 | +## [v0.11.0](https://github.com/simvue-io/python-api/releases/tag/v0.11.0) - 2023-03-04 |
180 | 180 |
|
181 | 181 | * Support optional dataframe output from `get_runs`.
|
182 | 182 |
|
183 |
| -## [v0.10.1](https://github.com/simvue-io/client/releases/tag/v0.10.1) - 2023-03-03 |
| 183 | +## [v0.10.1](https://github.com/simvue-io/python-api/releases/tag/v0.10.1) - 2023-03-03 |
184 | 184 |
|
185 | 185 | * The worker process now no longer gives a long delay when a run has finished (now at most ~1 second).
|
186 | 186 | * The worker process ends when the `Run()` context ends or `close` is called, rather than only when the main process exits.
|
187 | 187 |
|
188 |
| -## [v0.10.0](https://github.com/simvue-io/client/releases/tag/v0.10.0) - 2023-02-07 |
| 188 | +## [v0.10.0](https://github.com/simvue-io/python-api/releases/tag/v0.10.0) - 2023-02-07 |
189 | 189 |
|
190 | 190 | * The `client` class can now be used to retrieve runs.
|
191 | 191 |
|
192 |
| -## [v0.9.1](https://github.com/simvue-io/client/releases/tag/v0.9.1) - 2023-01-25 |
| 192 | +## [v0.9.1](https://github.com/simvue-io/python-api/releases/tag/v0.9.1) - 2023-01-25 |
193 | 193 |
|
194 | 194 | * (Bug fix) Retries in POST/PUTs to REST APIs didn't happen.
|
195 | 195 | * Warn users if `allow_pickle=True` is required.
|
196 | 196 |
|
197 |
| -## [v0.9.0](https://github.com/simvue-io/client/releases/tag/v0.9.0) - 2023-01-25 |
| 197 | +## [v0.9.0](https://github.com/simvue-io/python-api/releases/tag/v0.9.0) - 2023-01-25 |
198 | 198 |
|
199 | 199 | * Set status to `failed` or `terminated` if the context manager is used and there is an exception.
|
200 | 200 |
|
201 |
| -## [v0.8.0](https://github.com/simvue-io/client/releases/tag/v0.8.0) - 2023-01-23 |
| 201 | +## [v0.8.0](https://github.com/simvue-io/python-api/releases/tag/v0.8.0) - 2023-01-23 |
202 | 202 |
|
203 | 203 | * Support NumPy arrays, PyTorch tensors, Matplotlib and Plotly plots and picklable Python objects as artifacts.
|
204 | 204 | * (Bug fix) Events in offline mode didn't work.
|
205 | 205 |
|
206 |
| -## [v0.7.2](https://github.com/simvue-io/client/releases/tag/v0.7.2) - 2023-01-08 |
| 206 | +## [v0.7.2](https://github.com/simvue-io/python-api/releases/tag/v0.7.2) - 2023-01-08 |
207 | 207 |
|
208 | 208 | * Pydantic model is used for input validation.
|
209 | 209 | * Support NaN, -inf and inf in metadata and metrics.
|
210 | 210 |
|
211 |
| -## [v0.7.0](https://github.com/simvue-io/client/releases/tag/v0.7.0) - 2022-12-05 |
| 211 | +## [v0.7.0](https://github.com/simvue-io/python-api/releases/tag/v0.7.0) - 2022-12-05 |
212 | 212 |
|
213 | 213 | * Collect CPU, GPU and memory resource metrics.
|
214 | 214 | * Automatically delete temporary files used in offline mode once runs have entered a terminal state.
|
215 | 215 | * Warn users if their access token has expired.
|
216 | 216 | * Remove dependency on the randomname module, instead handle name generation server side.
|
217 | 217 |
|
218 |
| -## [v0.6.0](https://github.com/simvue-io/client/releases/tag/v0.6.0) - 2022-11-07 |
| 218 | +## [v0.6.0](https://github.com/simvue-io/python-api/releases/tag/v0.6.0) - 2022-11-07 |
219 | 219 |
|
220 | 220 | * `offline` and `disabled` options replaced with single `mode` flag.
|
221 | 221 |
|
222 |
| -## [v0.5.0](https://github.com/simvue-io/client/releases/tag/v0.5.0) - 2022-11-03 |
| 222 | +## [v0.5.0](https://github.com/simvue-io/python-api/releases/tag/v0.5.0) - 2022-11-03 |
223 | 223 |
|
224 | 224 | * Added option to disable all monitoring.
|
225 | 225 |
|
226 |
| -## [v0.4.0](https://github.com/simvue-io/client/releases/tag/v0.4.0) - 2022-11-03 |
| 226 | +## [v0.4.0](https://github.com/simvue-io/python-api/releases/tag/v0.4.0) - 2022-11-03 |
227 | 227 |
|
228 | 228 | * Offline mode added, enabling tracking of simulations running on worker nodes without outgoing network access.
|
229 | 229 | * Argument to `init` enabling runs to be left in the `created` state changed from `status="created"` to `running=True`.
|
230 | 230 | * Improvements to error handling.
|
231 | 231 |
|
232 |
| -## [v0.3.0](https://github.com/simvue-io/client/releases/tag/v0.3.0) - 2022-10-31 |
| 232 | +## [v0.3.0](https://github.com/simvue-io/python-api/releases/tag/v0.3.0) - 2022-10-31 |
233 | 233 |
|
234 | 234 | * Update `add_alert` method to support either metrics or events based alerts.
|
235 | 235 |
|
236 |
| -## [v0.2.0](https://github.com/simvue-io/client/releases/tag/v0.2.0) - 2022-10-26 |
| 236 | +## [v0.2.0](https://github.com/simvue-io/python-api/releases/tag/v0.2.0) - 2022-10-26 |
237 | 237 |
|
238 | 238 | * The previous `Simvue` class has been split into `Run` and `Client`. When creating a run use the new `Run` class rather than `Simvue`.
|
239 | 239 |
|
|
0 commit comments