galtimur commited on
Commit
dd1ee8c
1 Parent(s): aa3291b

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +16 -7
README.md CHANGED
@@ -20,24 +20,36 @@ To score your model on this dataset, you can use [**CI build repair benchmark**]
20
 
21
  ## How-to
22
 
23
- 1. List all the available configs
24
  via [`datasets.get_dataset_config_names`](https://huggingface.co/docs/datasets/v2.14.3/en/package_reference/loading_methods#datasets.get_dataset_config_names)
25
  and choose an appropriate one.
26
 
27
  Current configs: `python`
28
 
29
- 2. Load the data
30
  via [`load_dataset`](https://huggingface.co/docs/datasets/v2.14.3/en/package_reference/loading_methods#datasets.load_dataset):
31
 
32
- ```
33
  from datasets import load_dataset
34
 
35
  dataset = load_dataset("JetBrains-Research/lca-ci-builds-repair", split="test")
36
- ```
37
 
38
  Note that all the data we have is considered to be in the test split.
39
  **NOTE**: If you encounter any errors with loading the dataset on Windows, update the `datasets` library (was tested on `datasets==2.16.1`)
40
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
41
 
42
  ## Dataset Structure
43
 
@@ -46,9 +58,6 @@ followed by the commit that passes the workflow successfully.
46
 
47
  Note that, unlike other 🏟️ Long Code Arena datasets, this dataset does not contain repositories.
48
 
49
- * Our [CI builds repair benchmark](https://github.com/JetBrains-Research/lca-baselines/tree/main/ci-builds-repair/ci-builds-repair-benchmark) clones the necessary repos to the user's local machine.
50
- The user should run their model to repair the failing CI workflows, and the benchmark will push commits to GitHub,
51
- returning the results of the workflow runs for all the datapoints.
52
 
53
  ### Datapoint Schema
54
 
 
20
 
21
  ## How-to
22
 
23
+ ### List all the available configs
24
  via [`datasets.get_dataset_config_names`](https://huggingface.co/docs/datasets/v2.14.3/en/package_reference/loading_methods#datasets.get_dataset_config_names)
25
  and choose an appropriate one.
26
 
27
  Current configs: `python`
28
 
29
+ ### Load the data
30
  via [`load_dataset`](https://huggingface.co/docs/datasets/v2.14.3/en/package_reference/loading_methods#datasets.load_dataset):
31
 
 
32
  from datasets import load_dataset
33
 
34
  dataset = load_dataset("JetBrains-Research/lca-ci-builds-repair", split="test")
 
35
 
36
  Note that all the data we have is considered to be in the test split.
37
  **NOTE**: If you encounter any errors with loading the dataset on Windows, update the `datasets` library (was tested on `datasets==2.16.1`)
38
 
39
+ ### Usage
40
+
41
+ For the dataset usage please refer to our [CI builds repair benchmark](https://github.com/JetBrains-Research/lca-baselines/tree/main/ci-builds-repair/ci-builds-repair-benchmark).
42
+ Its workflow is following:
43
+
44
+ 1. Repairs repo by fix_repo_function function that utilizes repo state and logs of fails;
45
+ 2. Sends the datapoints to GitHub to run workflows;
46
+ 3. Requests results from GitHub;
47
+ 4. Analyzes results and prints them;
48
+ 5. Clones the necessary repos to the user's local machine.
49
+
50
+ The user should run their model to repair the failing CI workflows, and the benchmark will push commits to GitHub,
51
+ returning the results of the workflow runs for all the datapoints.
52
+
53
 
54
  ## Dataset Structure
55
 
 
58
 
59
  Note that, unlike other 🏟️ Long Code Arena datasets, this dataset does not contain repositories.
60
 
 
 
 
61
 
62
  ### Datapoint Schema
63