PeytonT commited on
Commit
d104f10
·
verified ·
1 Parent(s): 95ee887

Enhance model card with repository context and sources

Browse files
Files changed (1) hide show
  1. README.md +31 -17
README.md CHANGED
@@ -19,44 +19,60 @@ Reranks retrieved candidates with a cross-encoder scoring pass.
19
 
20
  - Artifact type: full fine-tuned model
21
  - Base model: `sentence-transformers/all-MiniLM-L6-v2`
 
22
  - Model ID: `L2`
23
  - Tier: `repository_library_search_stack`
24
- - Local mirror: `/arxiv/models/repository_library/cross-encoder-reranker`
25
- - Source checkpoint: `models/checkpoints/L2`
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: Reranks retrieved candidates with a cross-encoder scoring pass.
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:github_repos`
40
 
41
  ## Training Procedure
42
 
43
  - Sources: `github_repos`
44
  - Input fields: `query, candidate_row`
45
  - Target fields: `relevance_label`
 
46
  - Max samples: `4000`
 
47
  - Precision: `bf16`
48
  - Objective: `cross_entropy`
49
- - Batch size: `8`
50
  - Learning rate: `5e-05`
51
  - Max source tokens: `256`
52
  - Max target tokens: `256`
 
53
  - Max steps: `1000`
54
  - Notes: Search-stack role added to match models.md coverage; dataset builder may need role-specific supervised labels before promotion.
55
 
 
 
 
 
 
 
56
  ## Evaluation
57
 
58
  - Declared metrics: `accuracy`
59
- - Status: local experiment artifact mirrored for release; external benchmark reporting has not been standardized across the full model family yet.
60
 
61
  ## Usage
62
 
@@ -71,14 +87,12 @@ model = AutoModelForSequenceClassification.from_pretrained(repo_id)
71
 
72
  ## Limitations
73
 
74
- - These model cards reflect the packaged experiment configs and mirrored checkpoint contents, not an independently audited benchmark sheet.
75
- - Some training datasets are local corpora or exported shards, so reproducibility may require access to the surrounding Repository Library data pipeline.
76
- - Models in this stack are narrow components of a larger paper-and-repository system and should be validated on downstream tasks before deployment.
77
 
78
  ## Project Context
79
 
80
- 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.
81
-
82
- ## Contact
83
-
84
- 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: `L2`
24
  - Tier: `repository_library_search_stack`
25
+ - Role in stack: search-stack component for retrieval, reranking, or routing
 
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/cross-encoder-reranker`
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/l2_cross_encoder_reranker.json`
35
+ - Models directory: `https://github.com/peytontolbert/research_library/tree/main/models`
36
 
37
  ## Intended Use
38
 
39
  - Primary use: Reranks retrieved candidates with a cross-encoder scoring pass.
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 `github_repos`: repository graph and code chunk data exported from the Repository Library repo pipeline.
48
 
49
  ## Training Procedure
50
 
51
  - Sources: `github_repos`
52
  - Input fields: `query, candidate_row`
53
  - Target fields: `relevance_label`
54
+ - Train/val/test split: `[0.9, 0.1, 0.0]`
55
  - Max samples: `4000`
56
+ - Batch size: `8`
57
  - Precision: `bf16`
58
  - Objective: `cross_entropy`
 
59
  - Learning rate: `5e-05`
60
  - Max source tokens: `256`
61
  - Max target tokens: `256`
62
+ - Fine-tune strategy: `full_finetune`
63
  - Max steps: `1000`
64
  - Notes: Search-stack role added to match models.md coverage; dataset builder may need role-specific supervised labels before promotion.
65
 
66
+ ## Compute
67
+
68
+ - Hardware: not specified
69
+ - Distributed strategy: `unknown`
70
+ - Estimated GPU hours in config: `unknown`
71
+
72
  ## Evaluation
73
 
74
  - Declared metrics: `accuracy`
75
+ - Status: this card reflects the current tracked experiment configuration and packaged weights in the Repository Library model stack.
76
 
77
  ## Usage
78
 
 
87
 
88
  ## Limitations
89
 
90
+ - These cards are generated from tracked experiment metadata and packaged artifacts, not from a separate benchmark report or external audit.
91
+ - Several training sources are pipeline outputs from the Repository Library codebase rather than standalone public datasets.
92
+ - These models are components of a larger research system and should be validated in their target workflow before deployment.
93
 
94
  ## Project Context
95
 
96
+ - GitHub repository: `https://github.com/peytontolbert/research_library`
97
+ - Model collection: `https://huggingface.co/collections/PeytonT/research-library-6a49c589ef4d763f7539b50d`
98
+ - Publisher: `PeytonT`