Skip to content

Commit 5653013

Browse files
committed
Update Readme and add links
1 parent 8f077ff commit 5653013

1 file changed

Lines changed: 12 additions & 7 deletions

File tree

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,19 @@
33
[![uv](https://img.shields.io/badge/dependency%20manager-uv-orange.svg)](https://github.com/astral-sh/uv)
44
[![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
55
[![Release](https://img.shields.io/badge/release-1.0-blue.svg)]()
6-
<!-- [![Paper](https://img.shields.io/badge/paper-arXiv-red.svg)](todo) -->
6+
[![Paper](https://img.shields.io/badge/paper-arXiv-red.svg)](https://arxiv.org/pdf/2603.02001)
77
# Bespoke-OLAP
88

99
Sourcecode of the paper *Bespoke OLAP: Synthesizing Workload-Specific One-size-fits-one Database Engines*
1010

11-
The generated Cpp Artifacts of *Bespoke-TPCH* and *Bespoke-CEB* can be found here [https://github.com/DataManagementLab/BespokeOLAP_Artifacts](https://github.com/DataManagementLab/BespokeOLAP_Artifacts).
11+
**Quick links:** &nbsp;
12+
[📄 Paper](https://arxiv.org/pdf/2603.02001) &nbsp;·&nbsp;
13+
[🌐 Webpage](https://datamanagementlab.github.io/BespokeOLAP/) &nbsp;·&nbsp;
14+
[▶ Live Runner](https://datamanagementlab.github.io/BespokeOLAP/web-runner/)
1215

13-
An LLM agent that automatically generates and optimizes custom C++ OLAP query engines for user specified workloads. The agent generates C++ code, compiles it, and iteratively improves performance through sophisticaed optimization loops. Results are tracked in Weights & Biases (wandb).
16+
The generated C++ artifacts of *Bespoke-TPCH* and *Bespoke-CEB* are available in the [BespokeOLAP_Artifacts](https://github.com/DataManagementLab/BespokeOLAP_Artifacts) repository.
17+
18+
An LLM agent that automatically generates and optimizes custom C++ OLAP query engines for user specified workloads. The agent generates C++ code, compiles it, and iteratively improves performance through sophisticated optimization loops. Results are tracked in Weights & Biases (wandb).
1419

1520
<div align="center">
1621
<figure>
@@ -93,7 +98,7 @@ Place TPC-H or CEB Parquet files in your artifacts directory (default: `/mnt/lab
9398

9499
## Usage
95100

96-
### 1. Actvate your Python environment
101+
### 1. Activate your Python environment
97102

98103
```bash
99104
source .venv/bin/activate
@@ -134,7 +139,7 @@ python run_gen_base_impl.py \
134139
Conv name represents: `basef{q_id}-{q_id}v{version}`. For example, `basef1-22v1` is a base implementation generated for TPC-H queries 1 and 22, version 1.
135140

136141
### 4. Run the optimization loop
137-
To run the optimizaiton loop, please specify the wandb run-id of the run producing the base implementation (see 3.).
142+
To run the optimization loop, please specify the wandb run-id of the run producing the base implementation (see 3.).
138143
The script will automatically look up the final snapshot created at the end of that conversation and load this git snapshot automatically.
139144
I.e. any past run can be loaded as a starting point for the optimization loop, as long as the final snapshot of that run is available in the git cache. This allows you to easily continue and optimize from any past run, or even share runs across machines by sharing the git snapshot cache (see "Remote snapshot cache" below).
140145
Store the wandb run-id in the `run_optim_loop.py` header.
@@ -160,7 +165,7 @@ Conversation names are used to organize and track runs.
160165
They first create separate log-files but also identify traces, snapshots, and metrics in wandb.
161166
Further they reference the queries for which an engine is generated and optimized, as well as the version number for the generated engine.
162167
Hence they have to be unique - this is also enforced by the system.
163-
Usually naming convensions (conversation name prefixes) are enforced by the scripts.
168+
Usually naming conventions (conversation name prefixes) are enforced by the scripts.
164169

165170
## Optionally
166171
### Run the agent manually (interactive)
@@ -183,7 +188,7 @@ See [Benchmarking guide](benchmark/README.md) for details and additional example
183188
## CLI Reference
184189

185190
Common arguments shared across entry points:
186-
(however the recommend to use the prepared scripts/steps listed above, which have the appropriate arguments pre-configured)
191+
(We recommend using the prepared scripts above, which have the appropriate arguments pre-configured.)
187192

188193
| Argument | Default | Description |
189194
|---------------------------|----------------------|------------------------------------------------------------------------------------------|

0 commit comments

Comments
 (0)