PeytonT commited on
Commit
d853712
·
verified ·
1 Parent(s): 716aad2

Enhance model card with repository context and sources

Browse files
Files changed (1) hide show
  1. README.md +31 -17
README.md CHANGED
@@ -19,43 +19,59 @@ Learns author and community representations from paper metadata and graph contex
19
 
20
  - Artifact type: full fine-tuned model
21
  - Base model: `sentence-transformers/all-MiniLM-L6-v2`
 
22
  - Model ID: `M5`
23
  - Tier: `T1_metadata`
24
- - Local mirror: `/arxiv/models/repository_library/author-embedding`
25
- - Source checkpoint: `models/checkpoints/M5`
26
 
27
- 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.
 
 
 
 
 
 
 
 
28
 
29
  ## Intended Use
30
 
31
  - Primary use: Learns author and community representations from paper metadata and graph context.
32
- - Secondary use: retrieval, ranking, planning, or scientific paper tooling inside the broader Repository Library system, depending on the model family.
33
- - 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.
34
 
35
  ## Training Data
36
 
37
- This package was trained from the following declared datasets or corpus sources:
38
 
39
- - `source:arxiv_metadata`
40
 
41
  ## Training Procedure
42
 
43
  - Sources: `arxiv_metadata`
44
  - Input fields: `author_id, graph_neighbors`
45
  - Target fields: `author_embedding`
 
46
  - Max samples: `4000`
 
47
  - Precision: `bf16`
48
  - Objective: `contrastive`
49
- - Batch size: `8`
50
  - Learning rate: `5e-05`
51
  - Max source tokens: `256`
52
  - Max target tokens: `128`
 
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
 
@@ -70,14 +86,12 @@ model = AutoModel.from_pretrained(repo_id)
70
 
71
  ## Limitations
72
 
73
- - These model cards reflect the packaged experiment configs and mirrored checkpoint contents, not an independently audited benchmark sheet.
74
- - Some training datasets are local corpora or exported shards, so reproducibility may require access to the surrounding Repository Library data pipeline.
75
- - Models in this stack are narrow components of a larger paper-and-repository system and should be validated on downstream tasks before deployment.
76
 
77
  ## Project Context
78
 
79
- 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.
80
-
81
- ## Contact
82
-
83
- Published under `PeytonT` from the local `repository_library` build.
 
19
 
20
  - Artifact type: full fine-tuned model
21
  - Base model: `sentence-transformers/all-MiniLM-L6-v2`
22
+ - Backbone type: `encoder`
23
  - Model ID: `M5`
24
  - Tier: `T1_metadata`
25
+ - Role in stack: metadata-layer component in the paper understanding stack
 
26
 
27
+ 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.
28
+
29
+ ## Model Sources
30
+
31
+ - Hugging Face repo: `https://huggingface.co/PeytonT/author-embedding`
32
+ - Hugging Face collection: `https://huggingface.co/collections/PeytonT/research-library-6a49c589ef4d763f7539b50d`
33
+ - GitHub repository: `https://github.com/peytontolbert/research_library`
34
+ - Experiment config: `https://github.com/peytontolbert/research_library/blob/main/models/experiments/m5_author_embedding.json`
35
+ - Models directory: `https://github.com/peytontolbert/research_library/tree/main/models`
36
 
37
  ## Intended Use
38
 
39
  - Primary use: Learns author and community representations from paper metadata and graph context.
40
+ - Downstream use: retrieval, ranking, planning, paper understanding, or cross-domain reasoning inside the broader Repository Library system, depending on the model family.
41
+ - Out of scope: production safety claims, benchmark claims beyond the tracked experiment config, or deployment without task-specific validation.
42
 
43
  ## Training Data
44
 
45
+ The training inputs for this package were assembled from the following Repository Library data sources:
46
 
47
+ - Source `arxiv_metadata`: arXiv metadata records spanning titles, abstracts, authors, and category labels.
48
 
49
  ## Training Procedure
50
 
51
  - Sources: `arxiv_metadata`
52
  - Input fields: `author_id, graph_neighbors`
53
  - Target fields: `author_embedding`
54
+ - Train/val/test split: `[0.9, 0.1, 0.0]`
55
  - Max samples: `4000`
56
+ - Batch size: `8`
57
  - Precision: `bf16`
58
  - Objective: `contrastive`
 
59
  - Learning rate: `5e-05`
60
  - Max source tokens: `256`
61
  - Max target tokens: `128`
62
+ - Fine-tune strategy: `full_finetune`
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
 
 
86
 
87
  ## Limitations
88
 
89
+ - These cards are generated from tracked experiment metadata and packaged artifacts, not from a separate benchmark report or external audit.
90
+ - Several training sources are pipeline outputs from the Repository Library codebase rather than standalone public datasets.
91
+ - These models are components of a larger research system and should be validated in their target workflow before deployment.
92
 
93
  ## Project Context
94
 
95
+ - GitHub repository: `https://github.com/peytontolbert/research_library`
96
+ - Model collection: `https://huggingface.co/collections/PeytonT/research-library-6a49c589ef4d763f7539b50d`
97
+ - Publisher: `PeytonT`