Commit 010ed48
authored
Add documentation for data generation, ETL pipeline, metrics, telemetry, and system adapters (#166)
* Add documentation for data generation, ETL pipeline, metrics, telemetry, and system adapters
- Introduced `data-generation-and-etl.md` detailing the data generation process, S3 layout, version and table metadata, supported datasets, mutations, and running data generation.
- Created `getting-started.md` to guide users through installation, building, and running SpiceBench, including data generation and ETL pipeline instructions.
- Added `metrics-and-telemetry.md` outlining the metrics collected during benchmarks, their sources, and export pipelines.
- Established `system-adapters.md` to describe the system adapter protocol, transport modes, method specifications, and lifecycle, along with templates for building new adapters.
* docs: update documentation for system adapters, configuration, and future AI-native benchmarks
* docs: update flowchart for SpiceBench run process and metrics collection
* Update system adapter examples with latest SpiceBench changes
* Add documentation for SpiceBench
- Introduced README.md for SpiceBench documentation, outlining architecture, getting started guide, CLI reference, system adapters, data generation & ETL, metrics & telemetry, configuration, and crate reference.
- Created crate-reference.md detailing API overview for all workspace crates, including dependency graph, key modules, defined metrics, and public types for each crate.
- Added data-generation-and-etl.md to explain the two-stage data pipeline for data generation and ETL processes, including S3 layout, version metadata, supported datasets, mutations, and running data generation.
- Developed system-adapters.md to describe the system adapter protocol, current support, transport modes, method specifications, adapter lifecycle, and guidelines for adapter development.
* Add documentation for data generation, ETL pipeline, metrics, telemetry, and system adapters
- Introduced `data-generation-and-etl.md` detailing the data generation process, S3 layout, version and table metadata, supported datasets, mutations, and running data generation.
- Created `getting-started.md` to guide users through installation, building, and running SpiceBench, including data generation and ETL pipeline instructions.
- Added `metrics-and-telemetry.md` outlining the metrics collected during benchmarks, their sources, and export pipelines.
- Established `system-adapters.md` to describe the system adapter protocol, transport modes, method specifications, and lifecycle, along with templates for building new adapters.
* docs: update documentation for system adapters, configuration, and future AI-native benchmarks
* docs: update flowchart for SpiceBench run process and metrics collection
* Add documentation for SpiceBench
- Introduced README.md for SpiceBench documentation, outlining architecture, getting started guide, CLI reference, system adapters, data generation & ETL, metrics & telemetry, configuration, and crate reference.
- Created crate-reference.md detailing API overview for all workspace crates, including dependency graph, key modules, defined metrics, and public types for each crate.
- Added data-generation-and-etl.md to explain the two-stage data pipeline for data generation and ETL processes, including S3 layout, version metadata, supported datasets, mutations, and running data generation.
- Developed system-adapters.md to describe the system adapter protocol, current support, transport modes, method specifications, adapter lifecycle, and guidelines for adapter development.
* feat: add create_tables method to all adapters for dataset management
* Add documentation for data generation, ETL pipeline, metrics, telemetry, and system adapters
- Introduced `data-generation-and-etl.md` detailing the data generation process, S3 layout, version and table metadata, supported datasets, mutations, and running data generation.
- Created `getting-started.md` to guide users through installation, building, and running SpiceBench, including data generation and ETL pipeline instructions.
- Added `metrics-and-telemetry.md` outlining the metrics collected during benchmarks, their sources, and export pipelines.
- Established `system-adapters.md` to describe the system adapter protocol, transport modes, method specifications, and lifecycle, along with templates for building new adapters.
* docs: update documentation for system adapters, configuration, and future AI-native benchmarks
* docs: update flowchart for SpiceBench run process and metrics collection
* Add documentation for SpiceBench
- Introduced README.md for SpiceBench documentation, outlining architecture, getting started guide, CLI reference, system adapters, data generation & ETL, metrics & telemetry, configuration, and crate reference.
- Created crate-reference.md detailing API overview for all workspace crates, including dependency graph, key modules, defined metrics, and public types for each crate.
- Added data-generation-and-etl.md to explain the two-stage data pipeline for data generation and ETL processes, including S3 layout, version metadata, supported datasets, mutations, and running data generation.
- Developed system-adapters.md to describe the system adapter protocol, current support, transport modes, method specifications, adapter lifecycle, and guidelines for adapter development.
* Add documentation for data generation, ETL pipeline, metrics, telemetry, and system adapters
- Introduced `data-generation-and-etl.md` detailing the data generation process, S3 layout, version and table metadata, supported datasets, mutations, and running data generation.
- Created `getting-started.md` to guide users through installation, building, and running SpiceBench, including data generation and ETL pipeline instructions.
- Added `metrics-and-telemetry.md` outlining the metrics collected during benchmarks, their sources, and export pipelines.
- Established `system-adapters.md` to describe the system adapter protocol, transport modes, method specifications, and lifecycle, along with templates for building new adapters.
* docs: update documentation for system adapters, configuration, and future AI-native benchmarks
* Update system adapter examples with latest SpiceBench changes
* Add documentation for SpiceBench
- Introduced README.md for SpiceBench documentation, outlining architecture, getting started guide, CLI reference, system adapters, data generation & ETL, metrics & telemetry, configuration, and crate reference.
- Created crate-reference.md detailing API overview for all workspace crates, including dependency graph, key modules, defined metrics, and public types for each crate.
- Added data-generation-and-etl.md to explain the two-stage data pipeline for data generation and ETL processes, including S3 layout, version metadata, supported datasets, mutations, and running data generation.
- Developed system-adapters.md to describe the system adapter protocol, current support, transport modes, method specifications, adapter lifecycle, and guidelines for adapter development.
* feat: add create_tables method to all adapters for dataset management
* Address PR review comments and align with trunk
- Rewrite architecture.md intro and add Introduction section (wyattwenzel)
- Remove Spicepod-specific sections from configuration.md (phillipleblanc)
- Remove app/spicepod sections from crate-reference.md (phillipleblanc)
- Remove stray Distributed table row from architecture.md (phillipleblanc)
- Update README.md to reference three adapter methods (setup merged create_tables)
- Restore template files to trunk state (remove create_tables method)
- Update docs index descriptions
* feat: add setup-cc action to validation run steps in PR workflow
* fix: source environment variables for ADBC driver installation1 parent f935b8a commit 010ed48
18 files changed
Lines changed: 4260 additions & 320 deletions
File tree
- .claude/skills/system-adapter-builder
- .github/workflows
- crates/databricks-system-adapter
- docs
- system-adapters/templates
- go
- java/src/main/java/com/spicebench/template
- nodejs
- python
- rust/src
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | | - | |
| 3 | + | |
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
102 | 102 | | |
103 | 103 | | |
104 | 104 | | |
| 105 | + | |
| 106 | + | |
105 | 107 | | |
106 | 108 | | |
107 | 109 | | |
| |||
147 | 149 | | |
148 | 150 | | |
149 | 151 | | |
| 152 | + | |
150 | 153 | | |
151 | 154 | | |
152 | 155 | | |
| |||
Large diffs are not rendered by default.
0 commit comments