Edit README a bit & add config

README.md

@@ -1,42 +1,96 @@
 ---
 license: apache-2.0
 configs:
-- config_name: default
-  data_files:
-  - split: test
-    path: data/*.json
+  - config_name: python
+    data_files:
+      - split: test
+        path: data/python/*.json
 ---
 
-## Dataset
-The following dataset contains logs of the GitHub action for a failed workflow of some commits,
-followed by the commit that passes the workflow successfully. A full list of the datapoints' content is given below.
+# 🏟️ Long Code Arena (CI Fixing)
 
+> 🛠️ CI Fixing: given logs of a failed GitHub Actions workflow and the corresponding repository shapshot, fix the
+> repository contents in order to make the workflow pass.
 
-## Task
-The intended task for this dataset is to fix the repo to pass GitHub actions workflow.  
-Note that the dataset does not contain repo snapshot.
-During benchmark, the method clones the necessary repo on the user's local machine.
-The user's model should correct the files of the repo, and benchmark pushes repo to GitHub, returning the result of the workflow run aggregated by all datapoints.
+This is the benchmark for **CI Fixing** task as part of
+🏟️ [**Long Code Arena** benchmark](https://huggingface.co/spaces/JetBrains-Research/long-code-arena).
 
-## List of items of the datapoint:
+## How-to
+
+1. List all the available configs
+   via [`datasets.get_dataset_config_names`](https://huggingface.co/docs/datasets/v2.14.3/en/package_reference/loading_methods#datasets.get_dataset_config_names)
+   and choose an appropriate one.
+
+   Current configs: `python`
+
+2. Load the data
+   via [`load_dataset`](https://huggingface.co/docs/datasets/v2.14.3/en/package_reference/loading_methods#datasets.load_dataset):
+
+    ```
+    from datasets import load_dataset
+
+    configuration = "TODO"  # select a configuration
+    dataset = load_dataset("JetBrains-Research/lca-ci-fix", configuration, split="test")
+    ```
+
+   Note that all the data we have is considered to be in the test split.
+
+## Dataset Structure
+
+This dataset contains logs of the failed GitHub Action workflows for some commits
+followed by the commit that passes the workflow successfully.
+
+Note that, unlike many other 🏟 Long Code Arena datasets, this dataset doesn't contain repositories.
+
+* Our [CI Fixing benchmark](todo) (🚧 todo) clones the necessary repos to the user's local machine. The user should run their model to
+  fix the failing CI workflows, and the benchmark will push commits to GitHub, returning the results of the workflow runs
+  for all the datapoints.
+
+### Datapoint Schema
+
+**TODO** Add http links to failed commit  
+**TODO** Add file list of changed files
+
+Each example has the following fields:
+
+| Field               | Description                                                                                                                  |
+|---------------------|------------------------------------------------------------------------------------------------------------------------------|
+| `contributor`       | Username of the contributor that committed changes                                                                           |
+| `difficulty`        | Difficulty of the problem (assessor-based)                                                                                   |
+| `diff`              | Contents of the diff between the failed and the successful commits                                                           |
+| `head_branch`       | Name of the original branch that the commit was pushed at                                                                    |
+| `id`                | Unique ID of the datapoint                                                                                                   |
+| `language`          | Main language of the repo                                                                                                    |
+| `logs`              | List of dicts with keys `log` (logs of the failed job, particular step) and `step_name` (name of the failed step of the job) | |
+| `repo_name`         | Name of the original repo (second part of the `owner/name` on GitHub)                                                        |
+| `repo owner`        | Owner of the original repo (first part of the `owner/name` on GitHub)                                                        |
+| `sha_fail`          | SHA of the failed commit                                                                                                     |
+| `sha_success`       | SHA of the successful commit                                                                                                 |
+| `workflow`          | Contents of the workflow file                                                                                                |
+| `workflow_filename` | The name of the workflow file (without directories)                                                                          |
+| `workflow_name`     | The name of the workflow                                                                                                     |
+| `workflow_path`     | The full path to the workflow file                                                                                           |
+
+### Datapoint Example
 
 **TODO** Add http links to failed commit  
 **TODO** Add file list os changed files
 
-  **id**: unique id of the dp  
-  **language**: the main language of the repo  
-  **repo_name**: original repo name  
-  **repo_owner**: original repo owner  
-  **head_branch**: name of the original branch that the commit was pushed at  
-  **contributor**: username of the contributor that committed changes  
-  **difficulty**: the difficulty of the problem (accessor-based)  
-  **sha_fail**: sha of the failed commit  
-  **sha_success**: sha of the successful commit  
-  **diff:** the content of diff file between failed and successful commits  
-  **logs**: list of dicts [{"log": log, "step_name": step_name}]:  
-      - log: logs of the failed job, particular step  
-      - step_name: name of the failed step of the job  
-  **workflow**: content of the workflow file that has been used to run jobs  
-  **workflow_filename**: workflow filename that has been used to run jobs  
-  **workflow_name**: name of the workflow that was run  
-  **workflow_path**: path to the workflow file that was run
+```
+{'contributor': 'Gallaecio',
+ 'diff': 'diff --git a/scrapy/crawler.py b/scrapy/crawler.py/n<...>',
+ 'difficulty': '1',
+ 'head_branch': 'component-getters',
+ 'id': 18,
+ 'language': 'Python',
+ 'logs': [{'log': '##[group]Run pip install -U tox\n<...>',
+           'step_name': 'checks (3.12, pylint)/4_Run check.txt'}],
+ 'repo_name': 'scrapy',
+ 'repo_owner': 'scrapy',
+ 'sha_fail': '0f71221cf9875ed8ef3400e1008408e79b6691e6',
+ 'sha_success': 'c1ba9ccdf916b89d875628ba143dc5c9f6977430',
+ 'workflow': 'name: Checks\non: [push, pull_request]\n\n<...>',
+ 'workflow_filename': 'checks.yml',
+ 'workflow_name': 'Checks',
+ 'workflow_path': '.github/workflows/checks.yml'}
+```