Shuu12121 commited on
Commit
7751342
·
verified ·
1 Parent(s): dc75e48

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +28 -2
README.md CHANGED
@@ -46,10 +46,36 @@ configs:
46
  path: data/test-*
47
  ---
48
 
49
- # Python CodeSearchNet–Filtered
 
 
 
 
 
50
 
51
- Filtered to remove files from repositories appearing in the CodeSearchNet test split, deduplicated on identical docstring or code.
 
 
 
 
 
 
 
 
 
52
 
 
 
 
 
 
 
 
 
 
 
 
 
53
  ## Splits
54
  - **train**: 605,202 examples
55
  - **validation**: 10,728 examples
 
46
  path: data/test-*
47
  ---
48
 
49
+ ---
50
+ ## 📘 Dataset Description
51
+
52
+ This dataset contains Python functions and their documentation comments (`docstring`) extracted from public GitHub repositories. Each function is paired with metadata such as the repository name, file path, original license, and GitHub URL.
53
+
54
+ Only code licensed under the following OSI-approved permissive licenses was included:
55
 
56
+ - MIT
57
+ - Apache License 2.0
58
+ - BSD 2-Clause
59
+ - BSD 3-Clause
60
+ - ISC
61
+
62
+ These licenses permit reuse and redistribution (including commercial use) provided that proper attribution and license terms are preserved.
63
+
64
+ ---
65
+ ## 📄 Licensing and Legal Notice
66
 
67
+ All code snippets in this dataset were collected from public GitHub repositories that explicitly declare their licenses as one of the following: **MIT, Apache-2.0, BSD-2-Clause, BSD-3-Clause, or ISC**.
68
+
69
+ To comply with license terms:
70
+
71
+ - Each sample retains its license type in the `license` field.
72
+ - Repository names and GitHub URLs are included to allow proper attribution.
73
+ - License texts are available in the `LICENSES/` directory.
74
+ - No code from repositories lacking a license or using GPL-style licenses was included.
75
+
76
+ > ⚠️ **Disclaimer**: While care has been taken to ensure license compliance, users are responsible for verifying license terms and ensuring proper attribution when using this dataset in downstream applications.
77
+
78
+ ---
79
  ## Splits
80
  - **train**: 605,202 examples
81
  - **validation**: 10,728 examples