Shuu12121 commited on
Commit
0dc5ef8
·
verified ·
1 Parent(s): 02460d0

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +28 -0
README.md CHANGED
@@ -50,6 +50,34 @@ configs:
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**: 105,655 examples
55
  - **validation**: 5,565 examples
 
50
 
51
  Filtered to remove files from repositories appearing in the CodeSearchNet test split, deduplicated on identical docstring or code.
52
 
53
+ ## 📘 Dataset Description
54
+
55
+ This dataset contains Javascript 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.
56
+
57
+ Only code licensed under the following OSI-approved permissive licenses was included:
58
+
59
+ - MIT
60
+ - Apache License 2.0
61
+ - BSD 2-Clause
62
+ - BSD 3-Clause
63
+ - ISC
64
+
65
+ These licenses permit reuse and redistribution (including commercial use) provided that proper attribution and license terms are preserved.
66
+
67
+ ---
68
+ ## 📄 Licensing and Legal Notice
69
+
70
+ 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**.
71
+
72
+ To comply with license terms:
73
+
74
+ - Each sample retains its license type in the `license` field.
75
+ - Repository names and GitHub URLs are included to allow proper attribution.
76
+ - License texts are available in the `LICENSES/` directory.
77
+ - No code from repositories lacking a license or using GPL-style licenses was included.
78
+
79
+ > ⚠️ **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.
80
+
81
  ## Splits
82
  - **train**: 105,655 examples
83
  - **validation**: 5,565 examples