PeytonT commited on
Commit
b64c77d
·
verified ·
1 Parent(s): ab19855

Enhance model card with repository context and sources

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