PeytonT commited on
Commit
18f6c4a
·
verified ·
1 Parent(s): e59f7ea

Enhance model card with repository context and sources

Browse files
Files changed (1) hide show
  1. README.md +31 -17
README.md CHANGED
@@ -20,43 +20,59 @@ Ranks likely bug locations inside repository content.
20
 
21
  - Artifact type: full fine-tuned model
22
  - Base model: `allenai/scibert_scivocab_uncased`
 
23
  - Model ID: `R4`
24
  - Tier: `T4_repo`
25
- - Local mirror: `/arxiv/models/repository_library/bug-localization`
26
- - Source checkpoint: `models/checkpoints/R4`
27
 
28
- 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.
 
 
 
 
 
 
 
 
29
 
30
  ## Intended Use
31
 
32
  - Primary use: Ranks likely bug locations inside repository content.
33
- - Secondary use: retrieval, ranking, planning, or scientific paper tooling inside the broader Repository Library system, depending on the model family.
34
- - 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.
35
 
36
  ## Training Data
37
 
38
- This package was trained from the following declared datasets or corpus sources:
39
 
40
- - `source:github_repos`
41
 
42
  ## Training Procedure
43
 
44
  - Sources: `github_repos`
45
  - Input fields: `repo_context, failure_description`
46
  - Target fields: `bug_location`
 
47
  - Max samples: `4000`
 
48
  - Precision: `bf16`
49
  - Objective: `cross_entropy`
50
- - Batch size: `8`
51
  - Learning rate: `5e-05`
52
  - Max source tokens: `512`
53
  - Max target tokens: `128`
 
54
  - Max steps: `1000`
55
 
 
 
 
 
 
 
56
  ## Evaluation
57
 
58
  - Declared metrics: `accuracy, macro_f1`
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.
 
20
 
21
  - Artifact type: full fine-tuned model
22
  - Base model: `allenai/scibert_scivocab_uncased`
23
+ - Backbone type: `encoder`
24
  - Model ID: `R4`
25
  - Tier: `T4_repo`
26
+ - Role in stack: specialized Repository Library component
 
27
 
28
+ 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.
29
+
30
+ ## Model Sources
31
+
32
+ - Hugging Face repo: `https://huggingface.co/PeytonT/bug-localization`
33
+ - Hugging Face collection: `https://huggingface.co/collections/PeytonT/research-library-6a49c589ef4d763f7539b50d`
34
+ - GitHub repository: `https://github.com/peytontolbert/research_library`
35
+ - Experiment config: `https://github.com/peytontolbert/research_library/blob/main/models/experiments/r4_bug_localization.json`
36
+ - Models directory: `https://github.com/peytontolbert/research_library/tree/main/models`
37
 
38
  ## Intended Use
39
 
40
  - Primary use: Ranks likely bug locations inside repository content.
41
+ - Downstream use: retrieval, ranking, planning, paper understanding, or cross-domain reasoning inside the broader Repository Library system, depending on the model family.
42
+ - Out of scope: production safety claims, benchmark claims beyond the tracked experiment config, or deployment without task-specific validation.
43
 
44
  ## Training Data
45
 
46
+ The training inputs for this package were assembled from the following Repository Library data sources:
47
 
48
+ - Source `github_repos`: repository graph and code chunk data exported from the Repository Library repo pipeline.
49
 
50
  ## Training Procedure
51
 
52
  - Sources: `github_repos`
53
  - Input fields: `repo_context, failure_description`
54
  - Target fields: `bug_location`
55
+ - Train/val/test split: `[0.9, 0.1, 0.0]`
56
  - Max samples: `4000`
57
+ - Batch size: `8`
58
  - Precision: `bf16`
59
  - Objective: `cross_entropy`
 
60
  - Learning rate: `5e-05`
61
  - Max source tokens: `512`
62
  - Max target tokens: `128`
63
+ - Fine-tune strategy: `full_finetune`
64
  - Max steps: `1000`
65
 
66
+ ## Compute
67
+
68
+ - Hardware: 4x RTX_3090 (24 GB)
69
+ - Distributed strategy: `ddp`
70
+ - Estimated GPU hours in config: `0`
71
+
72
  ## Evaluation
73
 
74
  - Declared metrics: `accuracy, macro_f1`
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`