Datasets:

Modalities:
Text
Formats:
parquet
ArXiv:
Libraries:
Datasets
Dask
License:
SivilTaram commited on
Commit
d8026b3
1 Parent(s): d870c3a

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +22 -2
README.md CHANGED
@@ -22,7 +22,7 @@ configs:
22
  path: data/train-*
23
  ---
24
 
25
- # Dataset Card for StarCoder2-Documentation
26
 
27
  This dataset is the code documenation dataset used in [StarCoder2](https://huggingface.co/papers/2402.19173) pre-training, and it is also part of the-stack-v2-train-extras descried in the paper.
28
 
@@ -32,7 +32,27 @@ This dataset is the code documenation dataset used in [StarCoder2](https://huggi
32
 
33
  This dataset comprises a comprehensive collection of crawled documentation and code-related resources sourced from various package manager platforms and programming language documentation sites. It focuses on popular libraries, free programming books, and other relevant materials, facilitating research in software development, programming language trends, and documentation analysis.
34
 
35
- ### Sources
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
36
  1. **Package Managers:**
37
  - **npm:** Node.js package manager.
38
  - **PyPI:** Python Package Index.
 
22
  path: data/train-*
23
  ---
24
 
25
+ # Dataset Card
26
 
27
  This dataset is the code documenation dataset used in [StarCoder2](https://huggingface.co/papers/2402.19173) pre-training, and it is also part of the-stack-v2-train-extras descried in the paper.
28
 
 
32
 
33
  This dataset comprises a comprehensive collection of crawled documentation and code-related resources sourced from various package manager platforms and programming language documentation sites. It focuses on popular libraries, free programming books, and other relevant materials, facilitating research in software development, programming language trends, and documentation analysis.
34
 
35
+ ### How to Use it
36
+
37
+ ```python
38
+ from datasets import load_dataset
39
+
40
+ ds = load_dataset("SivilTaram/starcoder2-documentation")
41
+ ```
42
+
43
+ ### Data Fields
44
+
45
+ - **`project`** (`string`): The name or identifier of the project on each platform.
46
+ - **`source`** (`string`): The platform from which the documentation data is sourced.
47
+ - **`language`** (`string`): The identified programming language associated with the project.
48
+ - **`content`** (`string`): The text content of each document, formatted in Markdown.
49
+
50
+ ### Related Resources
51
+
52
+ For additional tools and methods related to converting HTML to Markdown, refer to the GitHub repository: [code-html-to-markdown](https://github.com/SivilTaram/code-html-to-markdown).
53
+
54
+ ### Data Sources
55
+
56
  1. **Package Managers:**
57
  - **npm:** Node.js package manager.
58
  - **PyPI:** Python Package Index.