Skip to content

Commit 2941194

Browse files
authored
[skip ci] Switch Changelog links to new repository
1 parent 051414c commit 2941194

File tree

1 file changed

+37
-37
lines changed

1 file changed

+37
-37
lines changed

CHANGELOG.md

Lines changed: 37 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Change log
22

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
44
* Add new example notebooks
55
* Update and refactor examples to work with v2.0
66
* Fix bug in offline artifacts using wrong file path
@@ -51,28 +51,28 @@
5151
* Adds additional functionality and support for offline mode.
5252
* Support for Simvue servers `>=3`.
5353

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
5555

5656
* Remove incorrect identifier reference for latest Simvue servers during reconnection.
5757
* Fixed missing online mode selection when retrieving configuration for `Client` class.
5858

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
6060

6161
* Fixed bug with `requirements.txt` metadata read.
6262
* Added Simvue server version check.
6363
* Remove checking of server version in offline mode and add default run mode to configuration options.
6464
* Fix offline mode class initialisation, and propagation of configuration.
6565

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
6767

6868
* Fix bug in offline mode directory retrieval.
6969

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
7171

7272
* Add missing `offline.cache` key to TOML config.
7373
* Fix repetition of server URL validation for each call to configuration.
7474

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
7676

7777
* Add option to specify a callback executed when an alert is triggered for a run.
7878
* Allow retrieval of all alerts when no constraints are specified.
@@ -83,35 +83,35 @@
8383
* Indicate the source used for token and URL.
8484
* Migrate to `simvue.toml` from `simvue.ini`, allowing more defaults to be set during runs.
8585

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
8787

8888
* Fix incorrect usage of `retry` when attempting connections to the server.
8989

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
9191

9292
* Ensure all functionality is deactivated when mode is set to `disabled`.
9393
* When an exception is thrown an event is sent to Simvue displaying the traceback.
9494
* If `add_process` is used and an exception is thrown, `.err` and `.out` files are still uploaded.
9595

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
9797

9898
* Set resource metrics to be recorded by default.
9999

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
101101

102102
* Fix issue of hanging threads when exception raised by script using the API.
103103

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
105105

106106
* Fix incorrect HTTP status code in `Client` when checking if object exists.
107107
* Fix issue with `running=False` when launching a `Run` caused by incorrect system metadata being sent to the server.
108108

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
110110

111111
* Fix to `add_process` with list of strings as arguments, the executable no longer returns the string `"None"`.
112112
* Fix callbacks and triggers for `add_process` being executed only on `Run` class termination, not on process completion.
113113

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
115115

116116
* Refactor and re-write of codebase to align with latest developments in version 2 of the Simvue server.
117117
* Added `Executor` to Simvue runs allowing users to start shell based processes as part of a run and handle termination of these.
@@ -121,119 +121,119 @@
121121
* 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.
122122
* Added support for `'user'` alerts.
123123

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
125125

126126
* Ensure import of the `requests` module is only done if actually used.
127127

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
129129

130130
* Added a method to the `Client` class for retrieving events.
131131

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
133133

134134
* Allow files (`input` and `code` only) to be saved for runs in the `created` state.
135135
* Allow metadata and tags to be updated for runs in the `created` state.
136136

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
138138

139139
* Added `plot_metrics` method to the `Client` class to simplify plotting metrics.
140140
* (Bug fix) `reconnect` works without a uuid being specified when `offline` mode isn't being used.
141141
* (Bug fix) Restrict version of Pydantic to prevent v2 from accidentally being used.
142142

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
144144

145145
* Set `sample_by` to 0 by default (no sampling) in `get_metrics_multiple`.
146146

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
148148

149149
* Added methods to the `Client` class for retrieving metrics.
150150
* CPU architecture and processor obtained on Apple hardware.
151151
* Client now reports to server when files have been successfully uploaded.
152152
* `User-Agent` header now included in HTTP requests.
153153

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
155155

156156
* Add methods to the `Client` class for deleting runs and folders.
157157
* Confusing messages about `process no longer exists` or `NVML Shared Library Not Found` no longer displayed.
158158

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
160160

161161
* (Bug fix) Ensure `simvue_sender` can be run when installed from PyPI.
162162
* (Bug fix) Runs created in `offline` mode using a context manager weren't automatically closed.
163163

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
165165

166166
* Added logging messages for debugging when debug level set to `debug`.
167167

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
169169

170170
* Raise exceptions in `Client` class methods if run does not exist or artifact does not exist.
171171
* (Bug fix) `list_artifacts` optional category restriction now works.
172172

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
174174

175175
* Support different runs having different metadata in `get_runs` dataframe output.
176176
* (Bug fix) Error message when creating a duplicate run is now more clear.
177177
* (Bug fix) Correction to stopping the worker thread in situations where the run never started.
178178

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
180180

181181
* Support optional dataframe output from `get_runs`.
182182

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
184184

185185
* The worker process now no longer gives a long delay when a run has finished (now at most ~1 second).
186186
* The worker process ends when the `Run()` context ends or `close` is called, rather than only when the main process exits.
187187

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
189189

190190
* The `client` class can now be used to retrieve runs.
191191

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
193193

194194
* (Bug fix) Retries in POST/PUTs to REST APIs didn't happen.
195195
* Warn users if `allow_pickle=True` is required.
196196

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
198198

199199
* Set status to `failed` or `terminated` if the context manager is used and there is an exception.
200200

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
202202

203203
* Support NumPy arrays, PyTorch tensors, Matplotlib and Plotly plots and picklable Python objects as artifacts.
204204
* (Bug fix) Events in offline mode didn't work.
205205

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
207207

208208
* Pydantic model is used for input validation.
209209
* Support NaN, -inf and inf in metadata and metrics.
210210

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
212212

213213
* Collect CPU, GPU and memory resource metrics.
214214
* Automatically delete temporary files used in offline mode once runs have entered a terminal state.
215215
* Warn users if their access token has expired.
216216
* Remove dependency on the randomname module, instead handle name generation server side.
217217

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
219219

220220
* `offline` and `disabled` options replaced with single `mode` flag.
221221

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
223223

224224
* Added option to disable all monitoring.
225225

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
227227

228228
* Offline mode added, enabling tracking of simulations running on worker nodes without outgoing network access.
229229
* Argument to `init` enabling runs to be left in the `created` state changed from `status="created"` to `running=True`.
230230
* Improvements to error handling.
231231

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
233233

234234
* Update `add_alert` method to support either metrics or events based alerts.
235235

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
237237

238238
* The previous `Simvue` class has been split into `Run` and `Client`. When creating a run use the new `Run` class rather than `Simvue`.
239239

0 commit comments

Comments
 (0)