magnus167/rustframe
1
0
Fork 0
mirror of https://github.com/Magnus167/rustframe.git synced 2025-08-20 23:40:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge b758b22b9317b25be5babb5227c0b09e3dd345f8 into 2bc375f95009e600ba8d584a88a2b59da7c0e8ef

Browse Source
This commit is contained in:
Palash Tyagi 2025-05-05 23:14:16 +00:00 committed by GitHub
commit cef18c2da3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 428 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
.github/htmldocs/index.html vendored Normal file
View File

@ -0,0 +1,74 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Rustframe</title>
<link rel="icon" type="image/png" href="./rustframe_logo.png">
<style>
body {
font-family: Arial, sans-serif;
background-color: #2b2b2b;
color: #d4d4d4;
margin: 0;
padding: 0;
display: flex;
justify-content: center;
align-items: center;
height: 100vh;
}
main {
text-align: center;
padding: 20px;
background-color: #3c3c3c;
border-radius: 10px;
box-shadow: 0 4px 8px rgba(0, 0, 0, 0.2);
max-width: 600px;
}
img {
max-width: 100px;
margin-bottom: 20px;
}
h1 {
/* logo is b35f20 */
color: #f8813f;
}
a {
color: #ff9a60;
text-decoration: none;
}
a:hover {
text-decoration: underline;
}
</style>
</head>
<body>
<main>
<h1>
<img src="./rustframe_logo.png" alt="Rustframe Logo"><br>
Rustframe
</h1>
<h2>A lightweight dataframe & math toolkit for Rust</h2>
<hr style="border: 1px solid #d4d4d4; margin: 20px 0;">
<p>
📚 <a href="https://magnus167.github.io/rustframe/docs">Docs</a> |
📊 <a href="https://magnus167.github.io/rustframe/benchmark-report/">Benchmarks</a>
<br><br>
🦀 <a href="https://crates.io/crates/rustframe">Crates.io</a> |
🔖 <a href="https://docs.rs/rustframe/latest/rustframe/">docs.rs</a>
<br><br>
🐙 <a href="https://github.com/Magnus167/rustframe">GitHub</a> |
🌐 <a href="https://gitea.nulltech.uk/Magnus167/rustframe">Gitea mirror</a>
</p>
</main>
</body>
</html>

8
.github/runners/runner-x64/Dockerfile vendored
View File

@ -7,7 +7,7 @@ ARG DEBIAN_FRONTEND=noninteractive
RUN apt update -y && apt upgrade -y && useradd -m docker
RUN apt install -y --no-install-recommends \
curl jq git \
curl jq git unzip \
# dev dependencies
build-essential libssl-dev libffi-dev python3 python3-venv python3-dev python3-pip \
# dot net core dependencies
@ -15,6 +15,12 @@ RUN apt install -y --no-install-recommends \
# Rust and Cargo dependencies
gcc cmake
# Install GitHub CLI
RUN curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | dd of=/usr/share/keyrings/githubcli-archive-keyring.gpg \
&& chmod go+r /usr/share/keyrings/githubcli-archive-keyring.gpg \
&& echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | tee /etc/apt/sources.list.d/github-cli.list > /dev/null \
&& apt update -y && apt install -y gh \
&& rm -rf /var/lib/apt/lists/*
# Install Rust and Cargo
RUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y

301
.github/scripts/custom_benchmark_report.py vendored Normal file
View File

@ -0,0 +1,301 @@
# create_benchmark_table.py
import argparse
import json
import re
import sys
from pathlib import Path
from pprint import pprint
from collections import defaultdict
from typing import Dict, Any, Optional
import pandas as pd
import html # Import the html module for escaping
# Regular expression to parse "test_name (size)" format
DIR_PATTERN = re.compile(r"^(.*?) \((.*?)\)$")
# Standard location for criterion estimates relative to the benchmark dir
ESTIMATES_PATH_NEW = Path("new") / "estimates.json"
# Fallback location (older versions or baseline comparisons)
ESTIMATES_PATH_BASE = Path("base") / "estimates.json"
# Standard location for the HTML report relative to the benchmark's specific directory
REPORT_HTML_RELATIVE_PATH = Path("report") / "index.html"
def load_criterion_reports(criterion_root_dir: Path) -> Dict[str, Dict[str, Dict[str, Any]]]:
"""
Loads Criterion benchmark results from a specified directory and finds HTML paths.
Args:
criterion_root_dir: The Path object pointing to the main
'target/criterion' directory.
Returns:
A nested dictionary structured as:
{ test_name: { size: {'json': json_content, 'html_path': relative_html_path}, ... }, ... }
Returns an empty dict if the root directory is not found or empty.
"""
results: Dict[str, Dict[str, Dict[str, Any]]] = defaultdict(dict)
if not criterion_root_dir.is_dir():
print(
f"Error: Criterion root directory not found or is not a directory: {criterion_root_dir}",
file=sys.stderr,
)
return {}
print(f"Scanning for benchmark reports in: {criterion_root_dir}")
for item in criterion_root_dir.iterdir():
# We are only interested in directories matching the pattern
if not item.is_dir():
continue
match = DIR_PATTERN.match(item.name)
if not match:
# print(f"Skipping directory (name doesn't match pattern): {item.name}")
continue
test_name = match.group(1).strip()
size = match.group(2).strip()
benchmark_dir_name = item.name # Store the original directory name
benchmark_dir_path = item # The Path object to the benchmark dir
json_path: Optional[Path] = None
# Look for the estimates JSON file (prefer 'new', fallback to 'base')
if (benchmark_dir_path / ESTIMATES_PATH_NEW).is_file():
json_path = benchmark_dir_path / ESTIMATES_PATH_NEW
elif (benchmark_dir_path / ESTIMATES_PATH_BASE).is_file():
json_path = benchmark_dir_path / ESTIMATES_PATH_BASE
# The HTML report is at a fixed location relative to the benchmark directory
html_path = benchmark_dir_path / REPORT_HTML_RELATIVE_PATH
if json_path is None or not json_path.is_file():
print(
f"Warning: Could not find estimates JSON in {benchmark_dir_path}. Skipping benchmark size '{test_name} ({size})'.",
file=sys.stderr,
)
continue # Skip if no JSON data
if not html_path.is_file():
print(
f"Warning: Could not find HTML report at expected location {html_path}. Skipping benchmark size '{test_name} ({size})'.",
file=sys.stderr,
)
continue # Skip if no HTML report
# Try loading the JSON data
try:
with json_path.open("r", encoding="utf-8") as f:
json_data = json.load(f)
# Store both the JSON data and the relative path to the HTML report
results[test_name][size] = {
'json': json_data,
# The path from the criterion root to the specific benchmark's report/index.html
'html_path_relative_to_criterion_root': str(Path(benchmark_dir_name) / REPORT_HTML_RELATIVE_PATH).replace('\\', '/') # Ensure forward slashes
}
# print(f" Loaded: {test_name} ({size}) from {json_path}, html: {html_path}")
except json.JSONDecodeError:
print(f"Error: Failed to decode JSON from {json_path}", file=sys.stderr)
except IOError as e:
print(f"Error: Failed to read file {json_path}: {e}", file=sys.stderr)
except Exception as e:
print(
f"Error: An unexpected error occurred loading {json_path}: {e}",
file=sys.stderr,
)
# Convert defaultdict back to regular dict for cleaner output (optional)
return dict(results)
def format_nanoseconds(ns: float) -> str:
"""Formats nanoseconds into a human-readable string with units."""
if pd.isna(ns):
return "-"
if ns < 1_000:
return f"{ns:.2f} ns"
elif ns < 1_000_000:
return f"{ns / 1_000:.2f} µs"
elif ns < 1_000_000_000:
return f"{ns / 1_000_000:.2f} ms"
else:
return f"{ns / 1_000_000_000:.2f} s"
def generate_html_table_with_links(results: Dict[str, Dict[str, Dict[str, Any]]], html_base_path: str) -> str:
"""
Generates an HTML table from benchmark results, with cells linking to reports.
Args:
results: The nested dictionary loaded by load_criterion_reports,
including 'json' data and 'html_path_relative_to_criterion_root'.
html_base_path: The base URL path where the 'target/criterion' directory
is hosted on the static site, relative to the output HTML file.
e.g., '../target/criterion/'
Returns:
A string containing the full HTML table.
"""
if not results:
return "<p>No benchmark results found or loaded.</p>"
# Get all unique sizes (columns) and test names (rows)
# Using ordered dictionaries to maintain insertion order from loading, then sorting keys
# Or simply sort the keys after extraction:
all_sizes = sorted(list(set(size for test_data in results.values() for size in test_data.keys())))
all_test_names = sorted(list(results.keys()))
html_string = """
<meta charset="utf-8">
<h1 id="criterion-benchmark-results">Criterion Benchmark Results</h1>
<p>Each cell links to the detailed Criterion report for that specific benchmark size.</p>
<p>Note: Values shown are the midpoint of the mean confidence interval, formatted for readability.</p>
<table class="table table-striped" border="1" justify="center">
<thead>
<tr>
<th>Benchmark Name</th>
"""
# Add size headers
for size in all_sizes:
html_string += f"<th>{html.escape(size)}</th>\n"
html_string += """
</tr>
</thead>
<tbody>
"""
# Add data rows
for test_name in all_test_names:
html_string += f"<tr>\n"
html_string += f" <td>{html.escape(test_name)}</td>\n"
# Iterate through all possible sizes to ensure columns align
for size in all_sizes:
cell_data = results.get(test_name, {}).get(size)
mean_value = pd.NA # Default value
full_report_url = "#" # Default link to self or dummy
if cell_data and 'json' in cell_data and 'html_path_relative_to_criterion_root' in cell_data:
try:
# Extract mean from JSON
mean_data = cell_data['json'].get("mean")
if mean_data and "confidence_interval" in mean_data:
ci = mean_data["confidence_interval"]
if "lower_bound" in ci and "upper_bound" in ci:
lower, upper = ci["lower_bound"], ci["upper_bound"]
if isinstance(lower, (int, float)) and isinstance(upper, (int, float)):
mean_value = (lower + upper) / 2.0
else:
print(f"Warning: Non-numeric bounds for {test_name} ({size}).", file=sys.stderr)
else:
print(f"Warning: Missing confidence_interval bounds for {test_name} ({size}).", file=sys.stderr)
else:
print(f"Warning: Missing 'mean' data for {test_name} ({size}).", file=sys.stderr)
# Construct the full relative URL
relative_report_path = cell_data['html_path_relative_to_criterion_root']
full_report_url = f"{html_base_path}{relative_report_path}"
# Ensure forward slashes and resolve potential double slashes if html_base_path ends in /
full_report_url = str(Path(full_report_url)).replace('\\', '/')
except Exception as e:
print(f"Error processing cell data for {test_name} ({size}): {e}", file=sys.stderr)
# Keep mean_value as NA and URL as '#'
# Format the mean value for display
formatted_mean = format_nanoseconds(mean_value)
# Create the link cell
# Only make it a link if a valid report path was found
if full_report_url and full_report_url != "#":
html_string += f' <td><a href="{html.escape(full_report_url)}">{html.escape(formatted_mean)}</a></td>\n'
else:
# Display value without a link if no report path
html_string += f' <td>{html.escape(formatted_mean)}</td>\n'
html_string += f"</tr>\n"
html_string += """
</tbody>
</table>
"""
return html_string
if __name__ == "__main__":
DEFAULT_CRITERION_PATH = "target/criterion"
# Default relative path from benchmark_results.html to the criterion root on the hosted site
# Assumes benchmark_results.html is in .../doc/<branch-slug>/benchmarks/
# And target/criterion is copied to .../doc/<branch-slug>/target/criterion/
# So the path from benchmarks/ to target/criterion/ is ../target/criterion/
DEFAULT_HTML_BASE_PATH = "../target/criterion/"
parser = argparse.ArgumentParser(
description="Load Criterion benchmark results from JSON files and generate an HTML table with links to reports."
)
parser.add_argument(
"--criterion-dir",
type=str,
default=DEFAULT_CRITERION_PATH,
help=f"Path to the main 'target/criterion' directory (default: {DEFAULT_CRITERION_PATH}) on the runner.",
)
parser.add_argument(
"--html-base-path",
type=str,
default=DEFAULT_HTML_BASE_PATH,
help=f"Relative URL path from the output HTML file to the hosted 'target/criterion' directory (default: {DEFAULT_HTML_BASE_PATH}).",
)
parser.add_argument(
"--output-file",
type=str,
default="benchmark_results.html",
help="Name of the output HTML file (default: benchmark_results.html)."
)
args = parser.parse_args()
criterion_path = Path(args.criterion_dir)
all_results = load_criterion_reports(criterion_path)
if not all_results:
print("\nNo benchmark results found or loaded.")
# Still create an empty file or a file with an error message
try:
with open(args.output_file, "w", encoding="utf-8") as f:
f.write("<h1>Criterion Benchmark Results</h1><p>No benchmark results found or loaded.</p>")
print(f"Created empty/error HTML file: {args.output_file}")
except IOError as e:
print(f"Error creating empty/error HTML file {args.output_file}: {e}", file=sys.stderr)
sys.exit(1) # Indicate failure if no data was loaded successfully
print("\nSuccessfully loaded benchmark results.")
# pprint(all_results) # Uncomment for debugging
print(f"Generating HTML table with links using base path: {args.html_base_path}")
html_output = generate_html_table_with_links(all_results, args.html_base_path)
try:
with open(args.output_file, "w", encoding="utf-8") as f:
f.write(html_output)
print(f"\nSuccessfully wrote HTML table to {args.output_file}")
sys.exit(0) # Exit successfully
except IOError as e:
print(f"Error writing HTML output to {args.output_file}: {e}", file=sys.stderr)
sys.exit(1)
except Exception as e:
print(f"An unexpected error occurred while writing HTML: {e}", file=sys.stderr)
sys.exit(1)

50
.github/workflows/docs-and-testcov.yml vendored
View File

@ -6,10 +6,14 @@ concurrency:
on:
push:
branches: [main]
branches: [main, docs_page]
# pull_request:
# branches: [main]
workflow_dispatch:
workflow_run:
workflows: ["run-benchmarks"]
types:
- completed
permissions:
contents: read
@ -100,6 +104,36 @@ jobs:
<(echo '{}') \
> last-commit-date.json
- name: Download last available benchmark report
run: |
artifact_url=$(gh api -H "Accept: application/vnd.github+json" \
/repos/${{ github.repository }}/actions/artifacts \
| jq -r '.artifacts[] | select(.name | startswith("benchmark-reports")) | .archive_download_url' | head -n 1)
if [ -z "$artifact_url" ]; then
echo "No benchmark artifact found!"
exit 1
fi
curl -L -H "Authorization: Bearer ${{ secrets.CUSTOM_GH_TOKEN }}" \
"$artifact_url" -o benchmark-report.zip
# Print all files in the current directory
echo "Files in the current directory:"
ls -al
# check if the zip file is valid
if ! unzip -tq benchmark-report.zip; then
echo "benchmark-report.zip is invalid or corrupted!"
exit 1
fi
unzip -q benchmark-report.zip -d benchmark-report
echo "<meta http-equiv=\"refresh\" content=\"0; url=report/index.html\">" > benchmark-report/index.html
- name: Copy files to output directory
run: |
# mkdir docs
@ -113,16 +147,16 @@ jobs:
cp last-commit-date.json target/doc/docs/
# cp -r .github target/doc/docs
cp .github/rustframe_logo.png target/doc/docs/
echo "<meta http-equiv=\"refresh\" content=\"0; url=docs\">" > target/doc/index.html
# echo "<meta http-equiv=\"refresh\" content=\"0; url=docs\">" > target/doc/index.html
touch target/doc/.nojekyll
# verify that logo exists in the output directory
- name: Verify logo directory
# copy the benchmark report to the output directory
cp -r benchmark-report target/doc/
- name: Add index.html to output directory
run: |
if [ ! -f target/doc/docs/rustframe_logo.png ]; then
echo "Logo not found in output directory!"
exit 1
fi
cp .github/htmldocs/index.html target/doc/index.html
cp .github/rustframe_logo.png target/doc/rustframe_logo.png
- name: Upload Pages artifact
# if: github.event_name == 'push' || github.event_name == 'workflow_dispatch'

2
.github/workflows/run-benchmarks.yml vendored
View File

@ -1,4 +1,4 @@
name: Run benchmarks
name: run-benchmarks
on:
workflow_dispatch:

4
.gitignore vendored
View File

@ -14,4 +14,6 @@ data/
.venv/
.vscode/
tarpaulin-report.*
tarpaulin-report.*
.github/htmldocs/rustframe_logo.png