argmin-checkpointing-file 0.1.0

Checkpointing to a file for argmin
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
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
60
61
62
63
64

<p align="center">
  <img
    width="400"
    src="https://raw.githubusercontent.com/argmin-rs/argmin/main/media/logo.png"
  />
</p>
<h1 align="center">argmin-checkpointing-file</h1>

<p align="center">
  <a href="https://argmin-rs.org">Website</a>
  |
  <a href="https://argmin-rs.org/book/">Book</a>
  |
  <a href="https://docs.rs/argmin-checkpointing-file">Docs (latest release)</a>
  |
  <a href="https://argmin-rs.github.io/argmin/argmin_checkpointing_file/index.html">Docs (main branch)</a>
</p>

<p align="center">
  <a href="https://crates.io/crates/argmin-checkpointing-file"
    ><img
      src="https://img.shields.io/crates/v/argmin-checkpointing-file?style=flat-square"
      alt="Crates.io version"
  /></a>
  <a href="https://crates.io/crates/argmin-checkpointing-file"
    ><img
      src="https://img.shields.io/crates/d/argmin-checkpointing-file?style=flat-square"
      alt="Crates.io downloads"
  /></a>
  <a href="https://github.com/argmin-rs/argmin/actions"
    ><img
      src="https://img.shields.io/github/actions/workflow/status/argmin-rs/argmin/ci.yml?branch=main&label=argmin CI&style=flat-square"
      alt="GitHub Actions workflow status"
  /></a>
  <img
    src="https://img.shields.io/crates/l/argmin-checkpointing-file?style=flat-square"
    alt="License"
  />
  <a href="https://discord.gg/fYB8AwxxMW"
    ><img
      src="https://img.shields.io/discord/1189119565335109683?style=flat-square&label=argmin%20Discord"
      alt="argmin Discord"
  /></a>
</p>

Saves a checkpoint on disk from which an interrupted optimization run can be resumed.
For details on the usage please see the documentation ([latest release](https://docs.rs/argmin-checkpointing-file)
or [current main](https://argmin-rs.github.io/argmin/argmin_checkpointing_file/index.html))
or the [argmin book](https://argmin-rs.org/book/) or have a look at
the [example](https://github.com/argmin-rs/argmin/tree/main/examples/checkpoint).

## License

Licensed under either of

  * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
  * MIT License ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.

### Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you,
as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.