paiml commited on
Commit
5950613
·
verified ·
1 Parent(s): 4fe2d0d

Upload corpus via rust-cli-docs-corpus

Browse files
Files changed (1) hide show
  1. README.md +89 -0
README.md ADDED
@@ -0,0 +1,89 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: apache-2.0
3
+ task_categories:
4
+ - text-generation
5
+ - text2text-generation
6
+ language:
7
+ - en
8
+ tags:
9
+ - rust
10
+ - documentation
11
+ - code
12
+ - cli
13
+ - lora
14
+ - fine-tuning
15
+ size_categories:
16
+ - n<1K
17
+ ---
18
+
19
+ # Rust CLI Documentation Corpus
20
+
21
+ A scientifically rigorous corpus for fine-tuning LLMs to generate idiomatic `///` documentation comments for Rust CLI tools.
22
+
23
+ ## Dataset Description
24
+
25
+ This corpus follows the Toyota Way principles and Popperian falsification methodology.
26
+
27
+ ### Statistics
28
+
29
+ - **Total entries:** 100
30
+ - **Source repositories:** 0
31
+ - **Validation score:** 96/100
32
+
33
+ ### Supported Tasks
34
+
35
+ - **Documentation Generation**: Generate Rust doc comments from code signatures
36
+ - **Code Understanding**: Learn Rust idioms and documentation patterns
37
+
38
+ ## Dataset Structure
39
+
40
+ ### Data Fields
41
+
42
+ | Field | Type | Description |
43
+ |-------|------|-------------|
44
+ | `id` | string | UUID v4 identifier |
45
+ | `input` | string | Rust code signature |
46
+ | `output` | string | Documentation comment |
47
+ | `category` | string | Doc type (function/argument/example/error/module) |
48
+ | `source_repo` | string | Source repository |
49
+ | `quality_score` | float32 | Quality score [0.0, 1.0] |
50
+
51
+ ### Data Splits
52
+
53
+ | Split | Percentage |
54
+ |-------|------------|
55
+ | train | 80% |
56
+ | validation | 10% |
57
+ | test | 10% |
58
+
59
+ ## Quality Validation
60
+
61
+ All entries pass 100-point Popperian falsification criteria.
62
+
63
+ ## Usage
64
+
65
+ ```python
66
+ from datasets import load_dataset
67
+
68
+ dataset = load_dataset("paiml/rust-cli-docs-corpus")
69
+ ```
70
+
71
+ ## License
72
+
73
+ Apache 2.0
74
+
75
+ ## Citation
76
+
77
+ ```bibtex
78
+ @dataset{paiml_rust_cli_docs,
79
+ title={Rust CLI Documentation Corpus},
80
+ author={PAIML},
81
+ year={2026},
82
+ publisher={HuggingFace}
83
+ }
84
+ ```
85
+
86
+ ## Provenance
87
+
88
+ - **Version**: 1.0.0
89
+ - **Hash**: 189432fe25f581af16b64682b2cf8ec65e443a65002a31095520744b01acbc7e