Ubuntu commited on
Commit
97df98a
Β·
1 Parent(s): 1dc83ef

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +13 -17
README.md CHANGED
@@ -31,41 +31,37 @@ This directory contains data for fine-tuning models and building RAGs for the do
31
  ## Overview
32
 
33
  - **data/**: Contains all datasets and indexes.
34
- - **raw_sample/**: Directories of raw PRs and diffs as collected from GitHub.
35
- - **raw_data.tar**: Collected PRs and diffs from GitHub.
36
- - **samples/**: JSONL files with processed samples suitable for dataset generation (e.g., HuggingFace).
37
- - **processed/**: Parquet or JSONL files for fine-tuning (e.g., `train.parquet`, `test.parquet`).
38
  - **faiss/**: Vector indexes for RAG workflows.
39
- - **scripts/**: Python and Node.js scripts for crawling, processing, and indexing.
40
 
41
  ## Data Structure
42
 
43
  ```
44
  data/
45
- β”œβ”€β”€ raw_data.tar
46
- β”œβ”€β”€ raw_sample/
47
- β”‚ β”œβ”€β”€ prs/
48
- β”‚ β”œβ”€β”€ diffs/
49
- β”‚ └── ... (extracted files)
50
  β”œβ”€β”€ processed/
51
  β”‚ β”œβ”€β”€ train.parquet
52
  β”‚ └── test.parquet
53
  └── faiss/
54
- └── index
 
55
  ```
56
 
57
- - **raw_data/**: Contains the full, unprocessed PR and diff data as collected from GitHub.
58
- - **samples/**: Contains JSONL files formatted for use with HuggingFace Datasets.
59
- - **processed/**: Contains files for model fine-tuning.
60
- - **faiss/**: Contains vector indexes for fast retrieval in RAG setups.
61
-
62
  ## Generated dataset
63
 
64
  PR is considered as a timeline with events. Input is PR metadata (title, description, label) and commit n-1, with all events between n-1 and n. Completion is n. It is possible to filter by time, label, authors, etc.
65
 
66
  ## Scripts
67
 
68
- See [scripts/README.md](scripts/README.md) for details on running the crawler, dataset generation, fine-tuning, and RAG indexing.
69
 
70
  ## PyTorch Dataset Example
71
 
 
31
  ## Overview
32
 
33
  - **data/**: Contains all datasets and indexes.
34
+ - **raw/sample/**: Sample PRs and diffs collected from GitHub.
35
+ - **raw_data.tar**: Archive of collected PRs and diffs from GitHub.
36
+ - **samples/**: Json files with processed samples suitable for dataset generation.
37
+ - **processed/**: Parquet files for fine-tuning (e.g., `train.parquet`, `test.parquet`).
38
  - **faiss/**: Vector indexes for RAG workflows.
39
+ - **scripts/**: Python and nodejs scripts for crawling, processing, and indexing.
40
 
41
  ## Data Structure
42
 
43
  ```
44
  data/
45
+ β”œβ”€β”€ raw/
46
+ | β”œβ”€β”€ sample/
47
+ β”‚ β”‚ β”œβ”€β”€ prs/
48
+ β”‚ β”‚ β”œβ”€β”€ diffs/
49
+ β”‚ └── raw_data.tar
50
  β”œβ”€β”€ processed/
51
  β”‚ β”œβ”€β”€ train.parquet
52
  β”‚ └── test.parquet
53
  └── faiss/
54
+ └── index.faiss
55
+ └── index.pkl
56
  ```
57
 
 
 
 
 
 
58
  ## Generated dataset
59
 
60
  PR is considered as a timeline with events. Input is PR metadata (title, description, label) and commit n-1, with all events between n-1 and n. Completion is n. It is possible to filter by time, label, authors, etc.
61
 
62
  ## Scripts
63
 
64
+ See [scripts/README.md](scripts/README.md) for details on running the crawler, dataset generation, and RAG indexing.
65
 
66
  ## PyTorch Dataset Example
67