PeytonT commited on
Commit
d8323fb
·
verified ·
1 Parent(s): bf954d2

Enhance model card with repository context and sources

Browse files
Files changed (1) hide show
  1. README.md +32 -18
README.md CHANGED
@@ -18,44 +18,60 @@ Scores abstract and code pairs using the paired-training variant of the abstract
18
 
19
  - Artifact type: LoRA adapter
20
  - Base model: `meta-llama/Llama-3.2-1B`
 
21
  - Model ID: `A1`
22
  - Tier: `T2_abstract`
23
- - Local mirror: `/arxiv/models/repository_library/abstract-code-relevance-pairs`
24
- - Source checkpoint: `models/checkpoints/a1`
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: Scores abstract and code pairs using the paired-training variant of the abstract-code-relevance model.
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_metadata`
39
- - `source:github_repos`
40
 
41
  ## Training Procedure
42
 
43
  - Sources: `arxiv_metadata, github_repos`
44
  - Input fields: `abstract`
45
  - Target fields: `repo_relevance`
 
46
  - Max samples: `0`
 
47
  - Precision: `bf16`
48
  - Objective: `contrastive`
49
- - Batch size: `4`
50
  - Learning rate: `0.0001`
51
  - Max source tokens: `2048`
52
  - Max target tokens: `512`
 
53
  - Max steps: `1000`
54
 
 
 
 
 
 
 
55
  ## Evaluation
56
 
57
  - Declared metrics: `recall_at_10, ndcg_at_10`
58
- - Status: local experiment artifact mirrored for release; external benchmark reporting has not been standardized across the full model family yet.
59
 
60
  ## Usage
61
 
@@ -73,14 +89,12 @@ model = PeftModel.from_pretrained(base, repo_id)
73
 
74
  ## Limitations
75
 
76
- - These model cards reflect the packaged experiment configs and mirrored checkpoint contents, not an independently audited benchmark sheet.
77
- - Some training datasets are local corpora or exported shards, so reproducibility may require access to the surrounding Repository Library data pipeline.
78
- - Models in this stack are narrow components of a larger paper-and-repository system and should be validated on downstream tasks before deployment.
79
 
80
  ## Project Context
81
 
82
- 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.
83
-
84
- ## Contact
85
-
86
- Published under `PeytonT` from the local `repository_library` build.
 
18
 
19
  - Artifact type: LoRA adapter
20
  - Base model: `meta-llama/Llama-3.2-1B`
21
+ - Backbone type: `decoder`
22
  - Model ID: `A1`
23
  - Tier: `T2_abstract`
24
+ - Role in stack: abstract-layer component for fast paper interpretation
 
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/abstract-code-relevance-pairs`
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/a1_abstract_code_relevance.json`
34
+ - Models directory: `https://github.com/peytontolbert/research_library/tree/main/models`
35
 
36
  ## Intended Use
37
 
38
  - Primary use: Scores abstract and code pairs using the paired-training variant of the abstract-code-relevance model.
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_metadata`: arXiv metadata records spanning titles, abstracts, authors, and category labels.
47
+ - Source `github_repos`: repository graph and code chunk data exported from the Repository Library repo pipeline.
48
 
49
  ## Training Procedure
50
 
51
  - Sources: `arxiv_metadata, github_repos`
52
  - Input fields: `abstract`
53
  - Target fields: `repo_relevance`
54
+ - Train/val/test split: `[0.8, 0.1, 0.1]`
55
  - Max samples: `0`
56
+ - Batch size: `4`
57
  - Precision: `bf16`
58
  - Objective: `contrastive`
 
59
  - Learning rate: `0.0001`
60
  - Max source tokens: `2048`
61
  - Max target tokens: `512`
62
+ - Fine-tune strategy: `peft_lora`
63
  - Max steps: `1000`
64
 
65
+ ## Compute
66
+
67
+ - Hardware: 4x RTX_3090 (24 GB)
68
+ - Distributed strategy: `ddp`
69
+ - Estimated GPU hours in config: `0`
70
+
71
  ## Evaluation
72
 
73
  - Declared metrics: `recall_at_10, ndcg_at_10`
74
+ - Status: this card reflects the current tracked experiment configuration and packaged weights in the Repository Library model stack.
75
 
76
  ## Usage
77
 
 
89
 
90
  ## Limitations
91
 
92
+ - These cards are generated from tracked experiment metadata and packaged artifacts, not from a separate benchmark report or external audit.
93
+ - Several training sources are pipeline outputs from the Repository Library codebase rather than standalone public datasets.
94
+ - These models are components of a larger research system and should be validated in their target workflow before deployment.
95
 
96
  ## Project Context
97
 
98
+ - GitHub repository: `https://github.com/peytontolbert/research_library`
99
+ - Model collection: `https://huggingface.co/collections/PeytonT/research-library-6a49c589ef4d763f7539b50d`
100
+ - Publisher: `PeytonT`