Skip to content

Commit

Permalink
Mention new timeout feature in 0.10.0 release post
Browse files Browse the repository at this point in the history
  • Loading branch information
stefan-k committed Feb 27, 2024
1 parent b64d336 commit ce905b9
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html) (since argmin version 0.5.0).

## [argmin unreleased]
* Added a new GUI observer called Spectator (`argmin-observer-spectator` and `spectator` packages) (@stefan-k, #311)

## [argmin-math unreleased]

## [argmin v0.10.0] 2024-02-27

### Added
* Added a new GUI observer called Spectator (`argmin-observer-spectator` and `spectator` packages) (@stefan-k, #311)
* Added optional timeout to Executor (@stefan-k, #405)

### Changed
Expand Down
15 changes: 15 additions & 0 deletions media/website/content/blog/version-v0.10.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,21 @@ Interrupt handling now includes `SIGINT`, `SIGTERM` and `SIGHUP`. Consequently,
`TerminationReason::KeyboardInterrupt` was renamed to `TerminationReason::Interrupt`.
This is a breaking change for those who match on `TerminationReason`.

##### Optional timeout

`Executor` now allows one to terminate a run after a given timeout, which can be set with the `timeout` method of `Executor`.
The check whether the overall runtime exceeds the timeout is performed after every iteration,
therefore the actual runtime can be longer than the set timeout.
In case of timeout, the run terminates with `TerminationReason::Timeout`.

The timeout is set via the `timeout` method of `Executor`:

```rust
let res = Executor::new(operator, solver)
.timeout(std::time::Duration::from_secs(3))
.run()?;
```

##### The optional `serde1` feature

With moving observers out of the argmin crate, it became easier to reason about the optional
Expand Down

0 comments on commit ce905b9

Please sign in to comment.