From 60e15ab17e8d7a0d3a98470021184a46d5f262dd Mon Sep 17 00:00:00 2001 From: Shunsuke Kanda Date: Sat, 26 Oct 2024 13:22:34 +0900 Subject: [PATCH] Set up to release CLI (#50) --- elinor-cli/Cargo.toml | 7 +++---- elinor-cli/README.md | 12 ++++++++++++ 2 files changed, 15 insertions(+), 4 deletions(-) diff --git a/elinor-cli/Cargo.toml b/elinor-cli/Cargo.toml index e1fb479..d8087a4 100644 --- a/elinor-cli/Cargo.toml +++ b/elinor-cli/Cargo.toml @@ -6,10 +6,8 @@ authors = ["Shunsuke Kanda (kampersanda) "] description = "Command line tools for elinor." license = "MIT OR Apache-2.0" readme = "README.md" -documentation = "https://docs.rs/elinor" -repository = "https://github.com/kampersanda/elinor" -homepage = "https://github.com/kampersanda/elinor" -keywords = ["information", "retrieval", "evaluation"] +repository = "https://github.com/kampersanda/elinor/tree/main/elinor-cli" +keywords = ["information", "retrieval", "evaluation", "cli"] categories = ["science"] rust-version = "1.65.0" @@ -22,6 +20,7 @@ prettytable-rs = "0.10.0" serde_json = "1.0.128" [dependencies.elinor] +version = "0.3.1" path = ".." features = ["serde"] default-features = false diff --git a/elinor-cli/README.md b/elinor-cli/README.md index 837381a..0070323 100644 --- a/elinor-cli/README.md +++ b/elinor-cli/README.md @@ -198,6 +198,12 @@ The output will be: +-------------+---------+ ``` +See the following documentation for more details about the statistical tests: + +- [Student's t-test](https://docs.rs/elinor/latest/elinor/statistical_tests/student_t_test/struct.StudentTTest.html) +- [Bootstrap test](https://docs.rs/elinor/latest/elinor/statistical_tests/bootstrap_test/struct.BootstrapTest.html) +- [Fisher's randomized test](https://docs.rs/elinor/latest/elinor/statistical_tests/randomized_tukey_hsd_test/struct.RandomizedTukeyHsdTest.html) + ### Example usage: Comparing three systems If you want to compare the metrics of three (or more) systems, run: @@ -267,6 +273,12 @@ The output will be: (The statistics for the other metrics will be shown as well.) ``` +See the following documentation for more details about the statistical tests: + +- [Two-way ANOVA without replication](https://docs.rs/elinor/latest/elinor/statistical_tests/two_way_anova_without_replication/struct.TwoWayAnovaWithoutReplication.html) +- [Tukey HSD test](https://docs.rs/elinor/latest/elinor/statistical_tests/tukey_hsd_test/struct.TukeyHsdTest.html) +- [Randomized Tukey HSD test](https://docs.rs/elinor/latest/elinor/statistical_tests/randomized_tukey_hsd_test/struct.RandomizedTukeyHsdTest.html) + ### Example usage: Printing the tables in a tab-separated format If you set `--print-mode raw`, the tables will be printed in a tab-separated format,