|
1 | 1 | # Change log
|
2 | 2 |
|
3 |
| -## v0.15.0 |
| 3 | +## Unreleased |
4 | 4 |
|
5 |
| -* Support v2 server. |
| 5 | +* Refactor and re-write of codebase to align with latest developments in version 2 of the Simvue server. |
| 6 | +* Added `Executor` to Simvue runs allowing users to start shell based processes as part of a run and handle termination of these. |
| 7 | +* Removal of obsolete functions due to server change, and renaming of functions and parameters (see [documentation](https://docs.simvue.io)). |
| 8 | +* Added pre-request validation to both `Client` and `Run` class methods via Pydantic. |
| 9 | +* Separation of save functionality into `save_file` and `save_object`. |
| 10 | +* 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. |
| 11 | +* Added support for `'user'` alerts. |
6 | 12 |
|
7 |
| -## v0.14.3 |
| 13 | +## [v0.14.3](https://github.com/simvue-io/client/releases/tag/v0.14.3) - 2023-06-29 |
8 | 14 |
|
9 | 15 | * Ensure import of the `requests` module is only done if actually used.
|
10 | 16 |
|
11 |
| -## v0.14.0 |
| 17 | +## [v0.14.0](https://github.com/simvue-io/client/releases/tag/v0.14.0) - 2023-04-04 |
12 | 18 |
|
13 | 19 | * Added a method to the `Client` class for retrieving events.
|
14 | 20 |
|
15 |
| -## v0.13.3 |
| 21 | +## [v0.13.3](https://github.com/simvue-io/client/releases/tag/v0.13.3) - 2023-04-04 |
16 | 22 |
|
17 | 23 | * Allow files (`input` and `code` only) to be saved for runs in the `created` state.
|
18 | 24 | * Allow metadata and tags to be updated for runs in the `created` state.
|
19 | 25 |
|
20 |
| -## v0.13.2 |
| 26 | +## [v0.13.2](https://github.com/simvue-io/client/releases/tag/v0.13.2) - 2023-04-04 |
21 | 27 |
|
22 | 28 | * Added `plot_metrics` method to the `Client` class to simplify plotting metrics.
|
23 | 29 | * (Bug fix) `reconnect` works without a uuid being specified when `offline` mode isn't being used.
|
24 | 30 | * (Bug fix) Restrict version of Pydantic to prevent V2 from accidently being used.
|
25 | 31 |
|
26 |
| -## v0.13.1 |
| 32 | +## [v0.13.1](https://github.com/simvue-io/client/releases/tag/v0.13.1) - 2023-03-28 |
27 | 33 |
|
28 | 34 | * Set `sample_by` to 0 by default (no sampling) in `get_metrics_multiple`.
|
29 | 35 |
|
30 |
| -## v0.13.0 |
| 36 | +## [v0.13.0](https://github.com/simvue-io/client/releases/tag/v0.13.0) - 2023-03-28 |
31 | 37 |
|
32 | 38 | * Added methods to the `Client` class for retrieving metrics.
|
33 | 39 | * CPU architecture and processor obtained on Apple hardware.
|
34 | 40 | * Client now reports to server when files have been successfully uploaded.
|
35 | 41 | * `User-Agent` header now included in HTTP requests.
|
36 | 42 |
|
37 |
| -## v0.12.0 |
| 43 | +## [v0.12.0](https://github.com/simvue-io/client/releases/tag/v0.12.0) - 2023-03-13 |
38 | 44 |
|
39 | 45 | * Add methods to the `Client` class for deleting runs and folders.
|
40 | 46 | * Confusing messages about `process no longer exists` or `NVML Shared Library Not Found` no longer displayed.
|
41 | 47 |
|
42 |
| -## v0.11.4 |
| 48 | +## [v0.11.4](https://github.com/simvue-io/client/releases/tag/v0.11.4) - 2023-03-13 |
43 | 49 |
|
44 | 50 | * (Bug fix) Ensure `simvue_sender` can be run when installed from PyPI.
|
45 | 51 | * (Bug fix) Runs created in `offline` mode using a context manager weren't automatically closed.
|
46 | 52 |
|
47 |
| -## v0.11.3 |
| 53 | +## [v0.11.3](https://github.com/simvue-io/client/releases/tag/v0.11.3) - 2023-03-07 |
48 | 54 |
|
49 | 55 | * Added logging messages for debugging when debug level set to `debug`.
|
50 | 56 |
|
51 |
| -## v0.11.2 |
52 |
| - |
| 57 | +## [v0.11.2](https://github.com/simvue-io/client/releases/tag/v0.11.2) - 2023-03-06 |
53 | 58 | * Raise exceptions in `Client` class methods if run does not exist or artifact does not exist.
|
54 | 59 | * (Bug fix) `list_artifacts` optional category restriction now works.
|
55 | 60 |
|
56 |
| -## v0.11.1 |
| 61 | +## [v0.11.1](https://github.com/simvue-io/client/releases/tag/v0.11.1) - 2023-03-05 |
57 | 62 |
|
58 | 63 | * Support different runs having different metadata in `get_runs` dataframe output.
|
59 | 64 | * (Bug fix) Error message when creating a duplicate run is now more clear.
|
60 | 65 | * (Bug fix) Correction to stopping the worker thread in situations where the run never started.
|
61 | 66 |
|
62 |
| -## v0.11.0 |
| 67 | +## [v0.11.0](https://github.com/simvue-io/client/releases/tag/v0.11.0) - 2023-03-04 |
63 | 68 |
|
64 | 69 | * Support optional dataframe output from `get_runs`.
|
65 | 70 |
|
66 |
| -## v0.10.1 |
| 71 | +## [v0.10.1](https://github.com/simvue-io/client/releases/tag/v0.10.1) - 2023-03-03 |
67 | 72 |
|
68 | 73 | * The worker process now no longer gives a long delay when a run has finished (now at most ~1 second).
|
69 | 74 | * The worker process ends when the `Run()` context ends or `close` is called, rather than only when the main process exits.
|
70 | 75 |
|
71 |
| -## v0.10.0 |
| 76 | +## [v0.10.0](https://github.com/simvue-io/client/releases/tag/v0.10.0) - 2023-02-07 |
72 | 77 |
|
73 | 78 | * The `client` class can now be used to retrieve runs.
|
74 | 79 |
|
75 |
| -## v0.9.1 |
| 80 | +## [v0.9.1](https://github.com/simvue-io/client/releases/tag/v0.9.1) - 2023-01-25 |
76 | 81 |
|
77 | 82 | * (Bug fix) Retries in POST/PUTs to REST APIs didn't happen.
|
78 | 83 | * Warn users if `allow_pickle=True` is required.
|
79 | 84 |
|
80 |
| -## v0.9.0 |
| 85 | +## [v0.9.0](https://github.com/simvue-io/client/releases/tag/v0.9.0) - 2023-01-25 |
81 | 86 |
|
82 | 87 | * Set status to `failed` or `terminated` if the context manager is used and there is an exception.
|
83 | 88 |
|
84 |
| -## v0.8.0 |
| 89 | +## [v0.8.0](https://github.com/simvue-io/client/releases/tag/v0.8.0) - 2023-01-23 |
85 | 90 |
|
86 | 91 | * Support NumPy arrays, PyTorch tensors, Matplotlib and Plotly plots and picklable Python objects as artifacts.
|
87 | 92 | * (Bug fix) Events in offline mode didn't work.
|
88 | 93 |
|
89 |
| -## v0.7.2 |
| 94 | +## [v0.7.2](https://github.com/simvue-io/client/releases/tag/v0.7.2) - 2023-01-08 |
90 | 95 |
|
91 | 96 | * Pydantic model is used for input validation.
|
92 | 97 | * Support NaN, -inf and inf in metadata and metrics.
|
93 | 98 |
|
94 |
| -## v0.7.0 |
| 99 | +## [v0.7.0](https://github.com/simvue-io/client/releases/tag/v0.7.0) - 2022-12-05 |
95 | 100 |
|
96 | 101 | * Collect CPU, GPU and memory resource metrics.
|
97 | 102 | * Automatically delete temporary files used in offline mode once runs have entered a terminal state.
|
98 | 103 | * Warn users if their access token has expired.
|
99 | 104 | * Remove dependency on the randomname module, instead handle name generation server side.
|
100 | 105 |
|
101 |
| -## v0.6.0 |
| 106 | +## [v0.6.0](https://github.com/simvue-io/client/releases/tag/v0.6.0) - 2022-11-07 |
102 | 107 |
|
103 | 108 | * `offline` and `disabled` options replaced with single `mode` flag.
|
104 | 109 |
|
105 |
| -## v0.5.0 |
| 110 | +## [v0.5.0](https://github.com/simvue-io/client/releases/tag/v0.5.0) - 2022-11-03 |
106 | 111 |
|
107 | 112 | * Added option to disable all monitoring.
|
108 | 113 |
|
109 |
| -## v0.4.0 |
| 114 | +## [v0.4.0](https://github.com/simvue-io/client/releases/tag/v0.4.0) - 2022-11-03 |
110 | 115 |
|
111 | 116 | * Offline mode added, enabling tracking of simulations running on worker nodes without outgoing network access.
|
112 | 117 | * Argument to `init` enabling runs to be left in the `created` state changed from `status="created"` to `running=True`.
|
113 | 118 | * Improvements to error handling.
|
114 | 119 |
|
115 |
| -## v0.3.0 |
| 120 | +## [v0.3.0](https://github.com/simvue-io/client/releases/tag/v0.3.0) - 2022-10-31 |
116 | 121 |
|
117 | 122 | * Update `add_alert` method to support either metrics or events based alerts.
|
118 | 123 |
|
119 |
| -## v0.2.0 |
| 124 | +## [v0.2.0](https://github.com/simvue-io/client/releases/tag/v0.2.0) - 2022-10-26 |
120 | 125 |
|
121 | 126 | * The previous `Simvue` class has been split into `Run` and `Client`. When creating a run use the new `Run` class rather than `Simvue`.
|
122 | 127 |
|
123 |
| -## v0.1.0 |
| 128 | +## [v0.1.0](https://github.com/simvue-io/client/releases/tag/v0.1.0) - 2022-10-25 |
124 | 129 |
|
125 | 130 | * First release.
|
0 commit comments