PeytonT commited on
Commit
99cf545
·
verified ·
1 Parent(s): 4023c59

Enhance model card with repository context and sources

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