andre15silva commited on
Commit
6644a65
·
1 Parent(s): b8c488a

add details in README

Browse files
Files changed (1) hide show
  1. README.md +40 -0
README.md CHANGED
@@ -37,3 +37,43 @@ configs:
37
  - split: train
38
  path: data/train-*
39
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
37
  - split: train
38
  path: data/train-*
39
  ---
40
+ # **Codeset-Gym-Python**
41
+
42
+ A gym for training code agents resolve real-world software issues. This version contains issues from Python repositories.
43
+
44
+ ---
45
+
46
+ ## Dataset Structure
47
+ | Column | Type | Description |
48
+ |-----|------|-------------|
49
+ | `instance_id` | `str` | Formatted as `owner__repo-issueNumber` (e.g. `psf__requests-6091`) |
50
+ | `repo` | `str` | `owner/repo` |
51
+ | `patch` | `str` | Source-code diff that resolves the issue *(tests omitted)* |
52
+ | `test_patch` | `str` | Diff of test files added/changed by the issue resolving commit |
53
+ | `base_commit` | `str` | Commit hash **before** the issue resolution |
54
+ | `environment_setup_commit` | `str` | Commit hash of the resolved version, from which the environment was built |
55
+ | `created_at` | `str` | ISO timestamp of the issue resolving commit |
56
+ | `problem_statement` | `str` | Issue title + body |
57
+ | `hints_text` | `str` | Concatenated Issue comments prior to the patch |
58
+ | `version` | `str` | Environment version tags |
59
+ | `FAIL_TO_PASS` | `List[str]` | A json list of strings that represent the set of tests resolved by the PR and tied to the issue resolution. |
60
+ | `PASS_TO_PASS` | `List[str]` | A json list of strings that represent tests that should pass before and after the PR application. |
61
+ ---
62
+
63
+ ## Usage
64
+
65
+ ```python
66
+ from datasets import load_dataset
67
+
68
+ ds = load_dataset("codeset/codeset-gym-python", split="train")
69
+
70
+ sample = ds[0]
71
+ print(sample["problem_statement"])
72
+ print(sample["patch"])
73
+ ```
74
+
75
+ The dataset ships as a single `train` split.
76
+
77
+ ---
78
+
79
+ Built by [Codeset](https://codeset.ai/)