Datasets:

Formats:
parquet
Languages:
English
ArXiv:
Tags:
code
DOI:
Libraries:
Datasets
pandas
License:
tiginamaria commited on
Commit
0c0b96e
1 Parent(s): cf324f6

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +4 -13
README.md CHANGED
@@ -431,16 +431,7 @@ This is the data for **Bug Localization** benchmark as part of LCA.
431
 
432
  ## How-to
433
 
434
- 1. Since the dataset is private, if you haven't used HF Hub before, add your token via `huggingface-cli` first:
435
-
436
- ```
437
- huggingface-cli login
438
- ```
439
-
440
- 2. 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
441
-
442
-
443
- 3. Load the data via [`load_dataset`](https://huggingface.co/docs/datasets/v2.14.3/en/package_reference/loading_methods#datasets.load_dataset):
444
 
445
  ```py
446
  from datasets import load_dataset
@@ -453,7 +444,7 @@ This is the data for **Bug Localization** benchmark as part of LCA.
453
  dataset = load_dataset("JetBrains-Research/lca-bug-localization", configuration, split=split)
454
  ```
455
 
456
- 4. Load repos via [`hf_hub_download`](https://huggingface.co/docs/huggingface_hub/v0.20.3/en/package_reference/file_download#huggingface_hub.hf_hub_download)
457
  ```py
458
  from huggingface_hub import hf_hub_download
459
  from datasets import load_dataset
@@ -485,8 +476,8 @@ This is the data for **Bug Localization** benchmark as part of LCA.
485
  os.remove(local_repo_zip_path)
486
  ```
487
 
488
- Moreover, all process of data loading and streaming is implemented in [HFDataSource](https://github.com/JetBrains-Research/lca-baselines/blob/main/bug_localization/src/baselines/data_sources/hf_data_source.py) which utilize Hugging Face data usage in benchmark infrastructure.
489
- We recommend using it as besides repository cloning process, it returns the state of the repository where bug is reproducable, by extraction repository content for the moment of the base commit sha of fixing pull request.
490
 
491
  ## Dataset Structure
492
 
 
431
 
432
  ## How-to
433
 
434
+ * Load the data via [`load_dataset`](https://huggingface.co/docs/datasets/v2.14.3/en/package_reference/loading_methods#datasets.load_dataset):
 
 
 
 
 
 
 
 
 
435
 
436
  ```py
437
  from datasets import load_dataset
 
444
  dataset = load_dataset("JetBrains-Research/lca-bug-localization", configuration, split=split)
445
  ```
446
 
447
+ * Load repos via [`hf_hub_download`](https://huggingface.co/docs/huggingface_hub/v0.20.3/en/package_reference/file_download#huggingface_hub.hf_hub_download)
448
  ```py
449
  from huggingface_hub import hf_hub_download
450
  from datasets import load_dataset
 
476
  os.remove(local_repo_zip_path)
477
  ```
478
 
479
+ * Data streaming by [HFDataSource](https://github.com/JetBrains-Research/lca-baselines/blob/main/bug_localization/src/baselines/data_sources/hf_data_source.py) \\
480
+ Besides data loading, `HFDataSource` returns data point for running baseline, providing the state of the repository where bug is reproducable, by extraction repository content for the moment of the base commit sha of fixing pull request.
481
 
482
  ## Dataset Structure
483