Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Multi-Language Serializer Benchmark

[![Site](https://img.shields.io/badge/site-storefront-indigo?style=flat-square)](https://leo-gan.github.io/GLD.SerializerBenchmark/)
[![Site](https://img.shields.io/badge/site-documentation-indigo?style=flat-square)](https://leo-gan.github.io/GLD.SerializerBenchmark/)
[![Dashboard](https://img.shields.io/badge/dashboard%20%7C%20live-brightgreen?style=flat-square)](https://leo-gan.github.io/GLD.SerializerBenchmark/dashboard/)
[![Serialization 101](https://img.shields.io/badge/Serialization%20101-8A2BE2?style=flat-square)](https://leo-gan.github.io/GLD.SerializerBenchmark/theory/101/)
[![License: MIT](https://img.shields.io/badge/license-MIT-blue?style=flat-square)](LICENSE)
Expand All @@ -10,17 +10,17 @@ Compare 100+ serialization libraries across **nine languages**.

| Start here | |
|------------|--|
| **Home** | [Project storefront](https://leo-gan.github.io/GLD.SerializerBenchmark/) (CTAs to Dashboard, Learn, Method) |
| **Home** | [Documentation](https://leo-gan.github.io/GLD.SerializerBenchmark/) |
| **Numbers** | [Live dashboard](https://leo-gan.github.io/GLD.SerializerBenchmark/dashboard/) · [Method overview](https://leo-gan.github.io/GLD.SerializerBenchmark/analysis/) |
| **Learn** | [Serialization 101–401](https://leo-gan.github.io/GLD.SerializerBenchmark/theory/101/) — students through systems engineers |
| **Method** | [How we measure](https://leo-gan.github.io/GLD.SerializerBenchmark/analysis/ANALYSIS_METHODOLOGY/) · [Metrics](https://leo-gan.github.io/GLD.SerializerBenchmark/analysis/METRICS/) |

<p align="center">
<a href="https://leo-gan.github.io/GLD.SerializerBenchmark/python/results/">
<img src="docs/analysis/plots/violin/python_message@n=1.png" alt="Python serialize/deserialize latency distribution for message data type (1 instance)" width="780" />
<a href="https://leo-gan.github.io/GLD.SerializerBenchmark/dashboard/">
<img src="docs/assets/dashboard-overview.jpg" alt="Live Dashboard: language and data-type filters, speed vs size scatter, and throughput ranking" width="780" />
</a>
<br />
<sub>Example: Python latency distribution for the <code>message</code> data type (1 instance). Full tables and charts on each language <strong>Results</strong> page.</sub>
<sub>The live <strong>Dashboard</strong>: pick a language and data type, then read speed vs size and the ranking.</sub>
</p>

---
Expand Down
2 changes: 1 addition & 1 deletion docs/analysis/BENCHMARK_SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Analysis documentation hub: [Method overview](index.md).

## Results by language

Alphabetical, same link pattern as the **Languages** menu and storefront: language name → overview, **Results** → measured snapshot.
Alphabetical, same link pattern as the **Languages** menu and documentation home: language name → overview, **Results** → measured snapshot.

| Language |
|----------|
Expand Down
Binary file added docs/assets/dashboard-overview.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 4 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,11 @@ ideally one format family), not to crown a single global winner.

## Same data · same pipeline

Example measurement output (Python, `message` data type, 1 instance). Full tables
and charts live on each language **Results** page and in the **Dashboard**.
The live **Dashboard** is the interactive view of the same measurements. Pick a
language and a data type, then read speed vs size and the ranking. Per-language
tables also live on each **Results** page.

[![Python serialize/deserialize latency distribution for message (n=1)](analysis/plots/violin/python_message@n=1.png){ width="780" }](python/results/)
[![Live Dashboard: language and data-type filters, speed vs size scatter, and throughput ranking](assets/dashboard-overview.jpg){ width="780" }](dashboard/)

---

Expand Down
2 changes: 1 addition & 1 deletion docs_theme/partials/content.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{#-
Override Material content partial:
honor page.meta.hide including "title" so the storefront has no in-page H1
honor page.meta.hide including "title" so the documentation home has no in-page H1
(the site header already shows the product name).
-#}
{% if "material/tags" in config.plugins and tags %}
Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ theme:
plugins:
- redirects:
redirect_maps:
# Site root is docs/index.md (storefront). Theory entry stays under Learn.
# Site root is docs/index.md (documentation home). Theory entry stays under Learn.
'theory/index.md': 'theory/101/index.md'
'theory/historical_perspective.md': 'theory/101/historical_perspective.md'
'theory/data_science_perspective.md': 'theory/101/data_science_perspective.md'
Expand Down
Loading