Skip to content

Commit 69fa906

Browse files
authored
Fix typos and enhance clarity in README.md
Corrected typos and improved clarity in the README.
1 parent d126523 commit 69fa906

File tree

1 file changed

+17
-25
lines changed

1 file changed

+17
-25
lines changed

README.md

Lines changed: 17 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,17 @@
44

55
![Build status](https://github.com/ldbc/ldbc_finbench_datagen/actions/workflows/ci.yml/badge.svg?branch=main)
66

7-
The LDBC FinBench Data Generator (Datagen) produces the datasets for
8-
the [LDBC FinBench's workloads](https://ldbcouncil.org/benchmarks/finbench/).
7+
The LDBC FinBench Data Generator (Datagen) produces the datasets for the [LDBC FinBench's workloads](https://ldbcouncil.org/benchmarks/finbench/).
98

10-
This data generator produces labelled directred property graphs based on the simulation of financial activities in
11-
business systems. The key features include generation, factorization and transformation. A detailed description of the
12-
schema produced by Datagen, as well as the format of the output files, can be found in the latest version of official
13-
LDBC FinBench specification document.
9+
This data generator produces labelled directed property graphs based on the simulation of financial activities in business systems. The key features include generation, factorization, and transformation. A detailed description of the schema produced by Datagen, as well as the format of the output files, can be found in the latest version of the official LDBC FinBench specification document.
10+
11+
Related Repositories:
12+
- FinBench Specification: https://github.com/ldbc/ldbc_finbench_docs
13+
- FinBench Driver: https://github.com/ldbc/ldbc_finbench_driver
14+
- FinBench Reference Implementation: https://github.com/ldbc/ldbc_finbench_transaction_impls
15+
- FinBench ACID Suite: https://github.com/ldbc/finbench-acid
16+
17+
**Note: The main branch is a work-in-progress for upcoming `v0.2` release aiming scale larger than SF100. For the stable version, please refer to version `0.1.0` on the `v0.1.0` branch.**
1418

1519
## DataGen Design
1620

@@ -36,41 +40,29 @@ Note:
3640

3741
- Java 8 installed.
3842
- Python3 and related packages installed. See each `install-dependencies.sh` for details.
39-
- Scala 2.12, note that it will be integrated when maven builds.
43+
- Scala 2.12, note that it will be integrated when Maven builds.
4044
- Spark deployed. Spark 3.2.x is the recommended runtime to use. The rest of the instructions are provided assuming
4145
Spark 3.2.x.
4246

4347
### Workflow
4448

45-
- Use the spark application to generate the factor tables and raw data.
46-
- Use the python scripts to transform the data to snapshot data and write queries.
49+
- Use the Spark application to generate the factor tables and raw data.
50+
- Use the Python scripts to transform the data into snapshot data and write queries.
4751

4852
### Generation of Raw Data
4953

5054
- Deploy Spark
51-
- use `scripts/get-spark-to-home.sh` to download pre-built spark to home directory and then decompress it.
55+
- Use `scripts/get-spark-to-home.sh` to download pre-built Spark to the home directory and then decompress it.
5256
- Set the PATH environment variable to include the Spark binaries.
5357
- Build the project
5458
- run `mvn clean package -DskipTests` to package the artifacts.
5559
- Run locally with scripts
56-
- See `scripts/run_local.sh` for details. It uses spark-submit to run the data generator. Please make sure you have
57-
the pre-requisites installed and the build is successful.
60+
- See `scripts/run_local.sh` for details. It uses spark-submit to run the data generator. Please ensure that you have the prerequisites installed and that the build is successful.
5861
- Run in cloud: To be supported
5962
- Run in cluster: To be supported
6063

6164
### Transformation of Raw Data
6265

63-
- set the `${FinBench_DATA_ROOT}` variable in `transformation/transform.sh` and run.
64-
65-
## TroubleShooting
66-
67-
N/A yet
68-
69-
# Related Work
70-
71-
- FinBench Specification: https://github.com/ldbc/ldbc_finbench_docs
72-
- FinBench Driver: https://github.com/ldbc/ldbc_finbench_driver
73-
- FinBench Reference Implementation: https://github.com/ldbc/ldbc_finbench_transaction_impls
74-
- FinBench ACID Suite: https://github.com/ldbc/finbench-acid
66+
- Set the `${FinBench_DATA_ROOT}` variable in `transformation/transform.sh` and run.
7567

76-
68+

0 commit comments

Comments
 (0)