PeytonT commited on
Commit
b5616ea
·
verified ·
1 Parent(s): 9fe2aa1

Enhance model card with repository context and sources

Browse files
Files changed (1) hide show
  1. README.md +32 -18
README.md CHANGED
@@ -20,44 +20,60 @@ Generates code-oriented outputs conditioned on paper content.
20
 
21
  - Artifact type: LoRA adapter
22
  - Base model: `google/flan-t5-base`
 
23
  - Model ID: `C1`
24
  - Tier: `T5_cross`
25
- - Local mirror: `/arxiv/models/repository_library/paper-to-code`
26
- - Source checkpoint: `models/checkpoints/C1`
27
 
28
- This repository is part of the `repository_library` model stack and is mirrored from `/data/repository_library/models/checkpoints` for publication under the `PeytonT` namespace.
 
 
 
 
 
 
 
 
29
 
30
  ## Intended Use
31
 
32
  - Primary use: Generates code-oriented outputs conditioned on paper content.
33
- - Secondary use: retrieval, ranking, planning, or scientific paper tooling inside the broader Repository Library system, depending on the model family.
34
- - Out of scope: production safety claims, benchmark claims beyond the bundled experiment config, or use outside the model's narrow training objective without task-specific validation.
35
 
36
  ## Training Data
37
 
38
- This package was trained from the following declared datasets or corpus sources:
39
 
40
- - `source:arxiv_pdfs_structured`
41
- - `source:github_repos`
42
 
43
  ## Training Procedure
44
 
45
  - Sources: `arxiv_pdfs_structured, github_repos`
46
  - Input fields: `method_text`
47
  - Target fields: `code_snippet`
 
48
  - Max samples: `4000`
 
49
  - Precision: `bf16`
50
  - Objective: `cross_entropy`
51
- - Batch size: `2`
52
  - Learning rate: `5e-05`
53
  - Max source tokens: `512`
54
  - Max target tokens: `256`
 
55
  - Max steps: `1000`
56
 
 
 
 
 
 
 
57
  ## Evaluation
58
 
59
  - Declared metrics: `perplexity, pass_at_1, pass_at_5`
60
- - Status: local experiment artifact mirrored for release; external benchmark reporting has not been standardized across the full model family yet.
61
 
62
  ## Usage
63
 
@@ -75,14 +91,12 @@ model = PeftModel.from_pretrained(base, repo_id)
75
 
76
  ## Limitations
77
 
78
- - These model cards reflect the packaged experiment configs and mirrored checkpoint contents, not an independently audited benchmark sheet.
79
- - Some training datasets are local corpora or exported shards, so reproducibility may require access to the surrounding Repository Library data pipeline.
80
- - Models in this stack are narrow components of a larger paper-and-repository system and should be validated on downstream tasks before deployment.
81
 
82
  ## Project Context
83
 
84
- Repository Library is a research system for indexing, retrieving, aligning, and reasoning over scientific papers, structured paper content, repositories, and cross-domain links between them.
85
-
86
- ## Contact
87
-
88
- Published under `PeytonT` from the local `repository_library` build.
 
20
 
21
  - Artifact type: LoRA adapter
22
  - Base model: `google/flan-t5-base`
23
+ - Backbone type: `encoder_decoder`
24
  - Model ID: `C1`
25
  - Tier: `T5_cross`
26
+ - Role in stack: specialized Repository Library component
 
27
 
28
+ This model is part of the Repository Library stack, a research system for indexing, retrieving, aligning, and reasoning over scientific papers, structured paper content, repositories, and cross-domain links between them.
29
+
30
+ ## Model Sources
31
+
32
+ - Hugging Face repo: `https://huggingface.co/PeytonT/paper-to-code`
33
+ - Hugging Face collection: `https://huggingface.co/collections/PeytonT/research-library-6a49c589ef4d763f7539b50d`
34
+ - GitHub repository: `https://github.com/peytontolbert/research_library`
35
+ - Experiment config: `https://github.com/peytontolbert/research_library/blob/main/models/experiments/c1_paper_to_code.json`
36
+ - Models directory: `https://github.com/peytontolbert/research_library/tree/main/models`
37
 
38
  ## Intended Use
39
 
40
  - Primary use: Generates code-oriented outputs conditioned on paper content.
41
+ - Downstream use: retrieval, ranking, planning, paper understanding, or cross-domain reasoning inside the broader Repository Library system, depending on the model family.
42
+ - Out of scope: production safety claims, benchmark claims beyond the tracked experiment config, or deployment without task-specific validation.
43
 
44
  ## Training Data
45
 
46
+ The training inputs for this package were assembled from the following Repository Library data sources:
47
 
48
+ - Source `arxiv_pdfs_structured`: structured PDF shards containing text, equations, figures, and tables.
49
+ - Source `github_repos`: repository graph and code chunk data exported from the Repository Library repo pipeline.
50
 
51
  ## Training Procedure
52
 
53
  - Sources: `arxiv_pdfs_structured, github_repos`
54
  - Input fields: `method_text`
55
  - Target fields: `code_snippet`
56
+ - Train/val/test split: `[0.9, 0.1, 0.0]`
57
  - Max samples: `4000`
58
+ - Batch size: `2`
59
  - Precision: `bf16`
60
  - Objective: `cross_entropy`
 
61
  - Learning rate: `5e-05`
62
  - Max source tokens: `512`
63
  - Max target tokens: `256`
64
+ - Fine-tune strategy: `peft_lora`
65
  - Max steps: `1000`
66
 
67
+ ## Compute
68
+
69
+ - Hardware: 4x RTX_3090 (24 GB)
70
+ - Distributed strategy: `ddp`
71
+ - Estimated GPU hours in config: `0`
72
+
73
  ## Evaluation
74
 
75
  - Declared metrics: `perplexity, pass_at_1, pass_at_5`
76
+ - Status: this card reflects the current tracked experiment configuration and packaged weights in the Repository Library model stack.
77
 
78
  ## Usage
79
 
 
91
 
92
  ## Limitations
93
 
94
+ - These cards are generated from tracked experiment metadata and packaged artifacts, not from a separate benchmark report or external audit.
95
+ - Several training sources are pipeline outputs from the Repository Library codebase rather than standalone public datasets.
96
+ - These models are components of a larger research system and should be validated in their target workflow before deployment.
97
 
98
  ## Project Context
99
 
100
+ - GitHub repository: `https://github.com/peytontolbert/research_library`
101
+ - Model collection: `https://huggingface.co/collections/PeytonT/research-library-6a49c589ef4d763f7539b50d`
102
+ - Publisher: `PeytonT`