Skip to content

Commit f2955b7

Browse files
committed
Update README
1 parent 802a985 commit f2955b7

File tree

1 file changed

+5
-16
lines changed

1 file changed

+5
-16
lines changed

README.md

Lines changed: 5 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,27 +9,16 @@ LDBC SNB implementations
99

1010
Implementations for the Workload components of the LDBC Social Network Benchmark ([specification](https://ldbc.github.io/ldbc_snb_docs/)).
1111

12-
:warning: The most recent version of the code can be found on the `dev` branch. The `master` branch tends to be better tested and uses a stable version of the LDBC SNB driver.
12+
This repository contains reference implementations for the two SNB workload:
1313

14-
:warning: Implementations in this repository are preliminary, i.e. they are unaudited and - in rare cases - do not pass validation. For details, feel free to contact us through an issue or email.
15-
16-
## Compatibility
17-
18-
The LDBC Social Network Benchmark suite is continuously maintained with improvements in the specification, the data generator, the driver, and the reference implementation.
19-
To ensure that you are using compatible LDBC repositories, use the following table:
14+
* `stable` contains implementations of the Interactive workload using Java clients and the [LDBC driver](https://github.com/ldbc/ldbc_snb_driver/). It uses data sets and parameters produced by the [Hadoop-based Datagen](https://github.com/ldbc/ldbc_snb_datagen/tree/stable). It is tested and had been used for audited benchmark runs.
15+
* `dev` contains implementations of the work-in-progress BI workload using Python clients and a lightweight driver (due to the simpler workflow of the workload). It uses data sets and parameters produced by the [Spark-based Datagen](https://github.com/ldbc/ldbc_snb_datagen). This implementation is experimental with frequent breaking changes.
2016

21-
| project | v0.3.x | v0.4.x |
22-
| ------- | ------ | ------ |
23-
| [Documentation](https://github.com/ldbc/ldbc_snb_docs) | [`v0.3.3`](https://github.com/ldbc/ldbc_snb_docs/releases/tag/v0.3.3) | [`dev`](https://github.com/ldbc/ldbc_snb_docs/tree/dev) |
24-
| [Datagen](https://github.com/ldbc/ldbc_snb_datagen) | [`v0.3.3`](https://github.com/ldbc/ldbc_snb_datagen/releases/tag/v0.3.3) | [`dev`](https://github.com/ldbc/ldbc_snb_datagen/tree/dev) |
25-
| [Driver](https://github.com/ldbc/ldbc_snb_driver) | [`v0.3.3`](https://github.com/ldbc/ldbc_snb_driver/releases/tag/0.3.3) | [`dev`](https://github.com/ldbc/ldbc_snb_driver/tree/dev) |
26-
| [Implementations](https://github.com/ldbc/ldbc_snb_implementations) | [`stable`](https://github.com/ldbc/ldbc_snb_implementations/tree/stable) | [`dev`](https://github.com/ldbc/ldbc_snb_implementations/tree/dev) |
27-
28-
The `stable` branches of the repositories correspond to the `v0.3.x`, and the `dev` branches correspond to the `v0.4.x` releases.
17+
:warning: Implementations in this repository are preliminary, i.e. they are unaudited and - in rare cases - do not pass validation. For details, feel free to contact us through an issue or email.
2918

3019
## Directory layout
3120

32-
Multiple configuration files and scripts use [relative paths to address the data generator's directory](https://github.com/ldbc/ldbc_snb_implementations/search?q=ldbc_snb_datagen). Hence, it is recommended to clone the LDBC Data Generator and the LDBC implementations repositories next to each other and keep their original directory names. For example:
21+
Some configuration files and scripts use [relative paths to address the data generator's directory](https://github.com/ldbc/ldbc_snb_implementations/search?q=ldbc_snb_datagen). Hence, it is recommended to clone the LDBC Data Generator and the LDBC implementations repositories next to each other and keep their original directory names. For example:
3322

3423
* `ldbc`
3524
* [`ldbc_snb_datagen`](https://github.com/ldbc/ldbc_snb_datagen)

0 commit comments

Comments
 (0)