Created READMEs for observers and checkpointing

crates/argmin-observer-paramwriter/Cargo.toml

@@ -15,7 +15,7 @@ exclude = []
 
 [dependencies]
 argmin = { version = "0.9.0", path = "../argmin", default-features = false }
-bincode = { version = "1.3.3" }
+bincode = { version = "1.3" }
 serde = { version = "1.0", features = ["derive", "rc"] }
 serde_json = { version = "1.0" }
 

crates/argmin-observer-paramwriter/README.md

@@ -0,0 +1,65 @@
+<p align="center">
+  <img
+    width="400"
+    src="https://raw.githubusercontent.com/argmin-rs/argmin/main/media/logo.png"
+  />
+</p>
+<h1 align="center">argmin-observer-paramwriter</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-observer-paramwriter">Docs (latest release)</a>
+  |
+  <a href="https://argmin-rs.github.io/argmin/argmin_observer_paramwriter/index.html">Docs (main branch)</a>
+</p>
+
+<p align="center">
+  <a href="https://crates.io/crates/argmin-observer-paramwriter"
+    ><img
+      src="https://img.shields.io/crates/v/argmin-observer-paramwriter?style=flat-square"
+      alt="Crates.io version"
+  /></a>
+  <a href="https://crates.io/crates/argmin-observer-paramwriter"
+    ><img
+      src="https://img.shields.io/crates/d/argmin-observer-paramwriter?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-observer-paramwriter?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>
+
+This argmin observer writes serialized parameter vectors to files during optimization.
+Details can be found in the documentation ([latest release](https://docs.rs/argmin-observer-paramwriter) or 
+[current main](https://argmin-rs.github.io/argmin/argmin_observer_paramwriter/index.html))
+or the [argmin book](https://argmin-rs.org/book/). 
+There is also an [example](https://github.com/argmin-rs/argmin/tree/main/examples/paramwriter)
+which illustrates how to use the observer.
+
+## 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.

crates/argmin-observer-slog/README.md

@@ -0,0 +1,63 @@
+<p align="center">
+  <img
+    width="400"
+    src="https://raw.githubusercontent.com/argmin-rs/argmin/main/media/logo.png"
+  />
+</p>
+<h1 align="center">argmin-observer-slog</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-observer-slog">Docs (latest release)</a>
+  |
+  <a href="https://argmin-rs.github.io/argmin/argmin_observer_slog/index.html">Docs (main branch)</a>
+</p>
+
+<p align="center">
+  <a href="https://crates.io/crates/argmin-observer-slog"
+    ><img
+      src="https://img.shields.io/crates/v/argmin-observer-slog?style=flat-square"
+      alt="Crates.io version"
+  /></a>
+  <a href="https://crates.io/crates/argmin-observer-slog"
+    ><img
+      src="https://img.shields.io/crates/d/argmin-observer-slog?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-observer-slog?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>
+
+This argmin observer logs the progress of the optimization to the terminal or to disk.
+Details can be found in the documentation ([latest release](https://docs.rs/argmin-observer-slog) or 
+[current main](https://argmin-rs.github.io/argmin/argmin_observer_slog/index.html))
+or the [argmin book](https://argmin-rs.org/book/). 
+
+## 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.