From 67d735d08edcbba0727db0f8d80fb3a859da4c18 Mon Sep 17 00:00:00 2001 From: Palash Tyagi <23239946+Magnus167@users.noreply.github.com> Date: Mon, 28 Apr 2025 19:21:15 +0100 Subject: [PATCH 01/15] fix README code --- README.md | 52 +++++++++++++++++++++++++++------------------------- 1 file changed, 27 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index d44e91c..18643f2 100644 --- a/README.md +++ b/README.md @@ -53,35 +53,37 @@ let dates: Vec = .list() .unwrap(); - let col_names: Vec = vec!["a".to_string(), "b".to_string()]; +let col_names: Vec = vec!["a".to_string(), "b".to_string()]; - let ma: Matrix = Matrix::from_cols(vec![vec![1.0, 2.0, 3.0, 4.0], vec![5.0, 6.0, 7.0, 8.0]]); - let mb: Matrix = Matrix::from_cols(vec![vec![4.0, 3.0, 2.0, 1.0], vec![8.0, 7.0, 6.0, 5.0]]); +let ma: Matrix = + Matrix::from_cols(vec![vec![1.0, 2.0, 3.0, 4.0], vec![5.0, 6.0, 7.0, 8.0]]); +let mb: Matrix = + Matrix::from_cols(vec![vec![4.0, 3.0, 2.0, 1.0], vec![8.0, 7.0, 6.0, 5.0]]); - let fa: Frame = Frame::new( - ma.clone(), - col_names.clone(), - Some(RowIndex::Date(dates.clone())), - ); - let fb: Frame = Frame::new(mb, col_names, Some(RowIndex::Date(dates))); +let fa: Frame = Frame::new( + ma.clone(), + Some(col_names.clone()), + Some(RowIndex::Date(dates.clone())), +); +let fb: Frame = Frame::new(mb, Some(col_names), Some(RowIndex::Date(dates))); - // Math that reads like math - let result: Frame = &fa * &fb; // element‑wise multiply - let total: f64 = result.sum_vertical().iter().sum::(); - assert_eq!(total, 184.0); +// Math that reads like math +let result: Frame = &fa * &fb; // element‑wise multiply +let total: f64 = result.sum_vertical().iter().sum::(); +assert_eq!(total, 184.0); - // broadcast & reduce - let result: Matrix = &ma + 1.0; // add scalar - let result: Matrix = &result - 1.0; // subtract scalar - let result: Matrix = &result * 2.0; // multiply by scalar - let result: Matrix = &result / 2.0; // divide by scalar +// broadcast & reduce +let result: Matrix = &ma + 1.0; // add scalar +let result: Matrix = &result - 1.0; // subtract scalar +let result: Matrix = &result * 2.0; // multiply by scalar +let result: Matrix = &result / 2.0; // divide by scalar - let check: bool = result.eq_elementwise(ma.clone()).all(); - assert!(check); +let check: bool = result.eq_elementwise(ma.clone()).all(); +assert!(check); - // The above math can also be written as: - let check: bool = (&(&(&(&ma + 1.0) - 1.0) * 2.0) / 2.0) - .eq_elementwise(ma) - .all(); - assert!(check); +// The above math can also be written as: +let check: bool = (&(&(&(&ma + 1.0) - 1.0) * 2.0) / 2.0) + .eq_elementwise(ma) + .all(); +assert!(check); ``` From 15f305fc17693bcc2fcefcbe87d6992d58e7fc6f Mon Sep 17 00:00:00 2001 From: Palash Tyagi <23239946+Magnus167@users.noreply.github.com> Date: Mon, 28 Apr 2025 19:22:46 +0100 Subject: [PATCH 02/15] fix README code example --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 18643f2..961ad3a 100644 --- a/README.md +++ b/README.md @@ -62,10 +62,10 @@ let mb: Matrix = let fa: Frame = Frame::new( ma.clone(), - Some(col_names.clone()), + col_names.clone(), Some(RowIndex::Date(dates.clone())), ); -let fb: Frame = Frame::new(mb, Some(col_names), Some(RowIndex::Date(dates))); +let fb: Frame = Frame::new(mb, col_names, Some(RowIndex::Date(dates))); // Math that reads like math let result: Frame = &fa * &fb; // element‑wise multiply From 840f99fdd72d0adf68f0a741a8ff57e54cdea765 Mon Sep 17 00:00:00 2001 From: Palash Tyagi <23239946+Magnus167@users.noreply.github.com> Date: Wed, 30 Apr 2025 13:54:57 +0100 Subject: [PATCH 03/15] Add logo image to README --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 961ad3a..52e0743 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +Rustframe + # rustframe πŸ“š [Docs](https://magnus167.github.io/rustframe/) | πŸ™ [GitHub](https://github.com/Magnus167/rustframe) | 🌐 [Gitea mirror](https://gitea.nulltech.uk/Magnus167/rustframe) | πŸ¦€ [Crates.io](https://crates.io/crates/rustframe) | πŸ”– [docs.rs](https://docs.rs/rustframe/latest/rustframe/) From 6447bf462719c6c62b3d48c5266599e84ab37938 Mon Sep 17 00:00:00 2001 From: Palash Tyagi <23239946+Magnus167@users.noreply.github.com> Date: Wed, 30 Apr 2025 18:10:19 +0100 Subject: [PATCH 04/15] Fix logo image path in README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 52e0743..c15617c 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -Rustframe +Rustframe # rustframe From f2c53719e7fc05b300a9b5dccf048e52c7852ea9 Mon Sep 17 00:00:00 2001 From: Palash Tyagi <23239946+Magnus167@users.noreply.github.com> Date: Wed, 30 Apr 2025 18:12:21 +0100 Subject: [PATCH 05/15] Add spacing above project title in README --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index c15617c..9147ef3 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ Rustframe +
+
+ # rustframe πŸ“š [Docs](https://magnus167.github.io/rustframe/) | πŸ™ [GitHub](https://github.com/Magnus167/rustframe) | 🌐 [Gitea mirror](https://gitea.nulltech.uk/Magnus167/rustframe) | πŸ¦€ [Crates.io](https://crates.io/crates/rustframe) | πŸ”– [docs.rs](https://docs.rs/rustframe/latest/rustframe/) From 3d3e29356eed925c736fa94371b795ab7b4b0154 Mon Sep 17 00:00:00 2001 From: Palash Tyagi <23239946+Magnus167@users.noreply.github.com> Date: Wed, 30 Apr 2025 18:37:44 +0100 Subject: [PATCH 06/15] Align logo image to the right in README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9147ef3..c25971b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -Rustframe +Rustframe

From ebaf3565cec5c6bf592a4b37f13a7a24e0709d31 Mon Sep 17 00:00:00 2001 From: Palash Tyagi <23239946+Magnus167@users.noreply.github.com> Date: Wed, 30 Apr 2025 18:38:41 +0100 Subject: [PATCH 07/15] Remove unnecessary line breaks in README --- README.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/README.md b/README.md index c25971b..d8dbfc6 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,5 @@ Rustframe -
-
- # rustframe πŸ“š [Docs](https://magnus167.github.io/rustframe/) | πŸ™ [GitHub](https://github.com/Magnus167/rustframe) | 🌐 [Gitea mirror](https://gitea.nulltech.uk/Magnus167/rustframe) | πŸ¦€ [Crates.io](https://crates.io/crates/rustframe) | πŸ”– [docs.rs](https://docs.rs/rustframe/latest/rustframe/) From 9ebc507f4a1d31ed4cf193546a92d94ce3a6ac74 Mon Sep 17 00:00:00 2001 From: Palash Tyagi <23239946+Magnus167@users.noreply.github.com> Date: Wed, 30 Apr 2025 18:39:09 +0100 Subject: [PATCH 08/15] Add line break above project title in README --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index d8dbfc6..cd0ff9c 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ Rustframe +
+ # rustframe πŸ“š [Docs](https://magnus167.github.io/rustframe/) | πŸ™ [GitHub](https://github.com/Magnus167/rustframe) | 🌐 [Gitea mirror](https://gitea.nulltech.uk/Magnus167/rustframe) | πŸ¦€ [Crates.io](https://crates.io/crates/rustframe) | πŸ”– [docs.rs](https://docs.rs/rustframe/latest/rustframe/) From 5c69ee3ac2c04f0977cbbb35ed05fe0b39f3852d Mon Sep 17 00:00:00 2001 From: Palash Tyagi <23239946+Magnus167@users.noreply.github.com> Date: Wed, 30 Apr 2025 18:39:42 +0100 Subject: [PATCH 09/15] Align logo image to the left in README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index cd0ff9c..5bf0a01 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -Rustframe +Rustframe
From d42f1cee6197683e3fb2f5daf155c6c98d83c7d9 Mon Sep 17 00:00:00 2001 From: Palash Tyagi <23239946+Magnus167@users.noreply.github.com> Date: Wed, 30 Apr 2025 18:40:14 +0100 Subject: [PATCH 10/15] Reduce logo height in README from 100 to 50 pixels --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5bf0a01..3b87ad8 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -Rustframe +Rustframe
From b6c548ba7a8317f3b34fc91fa5661b920da3cdc4 Mon Sep 17 00:00:00 2001 From: Palash Tyagi <23239946+Magnus167@users.noreply.github.com> Date: Wed, 30 Apr 2025 18:41:19 +0100 Subject: [PATCH 11/15] testing... --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index 3b87ad8..955cbc3 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,4 @@ -Rustframe - -
+Rustframe # rustframe From 70ad5d6be4ff7f542be85b06bd2018d068aea897 Mon Sep 17 00:00:00 2001 From: Palash Tyagi <23239946+Magnus167@users.noreply.github.com> Date: Wed, 30 Apr 2025 18:46:45 +0100 Subject: [PATCH 12/15] Center logo in README and reduce height from 75 to 50 pixels --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 955cbc3..cddb55d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,5 @@ -Rustframe -# rustframe +# Rustframe rustframe πŸ“š [Docs](https://magnus167.github.io/rustframe/) | πŸ™ [GitHub](https://github.com/Magnus167/rustframe) | 🌐 [Gitea mirror](https://gitea.nulltech.uk/Magnus167/rustframe) | πŸ¦€ [Crates.io](https://crates.io/crates/rustframe) | πŸ”– [docs.rs](https://docs.rs/rustframe/latest/rustframe/) From dc09ee7006520aba23d1eac89d493b9b5dccd6cb Mon Sep 17 00:00:00 2001 From: Palash Tyagi <23239946+Magnus167@users.noreply.github.com> Date: Wed, 30 Apr 2025 18:47:20 +0100 Subject: [PATCH 13/15] Add comment explaining the use of center tag in README --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index cddb55d..3a990ae 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # Rustframe rustframe + + πŸ“š [Docs](https://magnus167.github.io/rustframe/) | πŸ™ [GitHub](https://github.com/Magnus167/rustframe) | 🌐 [Gitea mirror](https://gitea.nulltech.uk/Magnus167/rustframe) | πŸ¦€ [Crates.io](https://crates.io/crates/rustframe) | πŸ”– [docs.rs](https://docs.rs/rustframe/latest/rustframe/) From dab2c758e6c37bee318e7c5ac543a28a9b38265a Mon Sep 17 00:00:00 2001 From: Palash Tyagi <23239946+Magnus167@users.noreply.github.com> Date: Thu, 1 May 2025 01:02:03 +0100 Subject: [PATCH 14/15] Add condition to skip tests for draft pull requests --- .github/workflows/run-unit-tests.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/run-unit-tests.yml b/.github/workflows/run-unit-tests.yml index ba90e9e..6fe312d 100644 --- a/.github/workflows/run-unit-tests.yml +++ b/.github/workflows/run-unit-tests.yml @@ -7,6 +7,7 @@ on: jobs: run-unit-tests: + if: github.event.pull_request.draft == false name: run-unit-tests runs-on: ubuntu-latest env: From ed51a74f6bcb1d625082f72e3932f727c462fda5 Mon Sep 17 00:00:00 2001 From: Palash Tyagi <23239946+Magnus167@users.noreply.github.com> Date: Thu, 1 May 2025 01:02:09 +0100 Subject: [PATCH 15/15] Add rustframe logo to documentation output --- .github/workflows/docs-and-testcov.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/docs-and-testcov.yml b/.github/workflows/docs-and-testcov.yml index 70cd1fe..2307ec2 100644 --- a/.github/workflows/docs-and-testcov.yml +++ b/.github/workflows/docs-and-testcov.yml @@ -86,6 +86,8 @@ jobs: cp tarpaulin-report.json target/doc/rustframe/ cp tarpaulin-badge.json target/doc/rustframe/ cp last-commit-date.json target/doc/rustframe/ + mkdir -p target/doc/rustframe/.github + cp .github/rustframe_logo.png target/doc/rustframe/.github/ echo "" > target/doc/index.html - name: Upload Pages artifact