assemsabry commited on
Commit
c8264a5
Β·
verified Β·
1 Parent(s): fc7091c

docs: keep training records on GitHub only

Browse files
Files changed (1) hide show
  1. README.md +23 -24
README.md CHANGED
@@ -1,6 +1,6 @@
1
  ---
2
  license: other
3
- license_name: tokenai-neo-model-license-v3.0
4
  license_link: https://huggingface.co/tokenaii/Neo/blob/main/licenses/MODEL_LICENSE.md
5
  library_name: pytorch
6
  pipeline_tag: text-classification
@@ -36,6 +36,11 @@ Canonical model: `tokenaii/Neo` β€” https://huggingface.co/tokenaii/Neo
36
 
37
  Training dataset: `tokenaii/Neo-dataset` β€” https://huggingface.co/datasets/tokenaii/Neo-dataset
38
 
 
 
 
 
 
39
  ## Model architecture
40
 
41
  - Bidirectional Transformer encoder, initialized and trained from scratch.
@@ -70,36 +75,31 @@ unsupervised medical, legal, financial, employment, housing, admissions,
70
  insurance, credit, safety-critical, government-benefit, law-enforcement, or
71
  irreversible decisions.
72
 
73
- ## Training data and procedure
 
 
 
 
74
 
75
- The English-only corpus contains 400,000 synthetic records and 1,000,000
76
- independent decisions: 799,882 training, 100,138 calibration, and 99,980 test
77
- decisions. The catalog contains 20 tools; records commonly present one target
78
- and five distractors.
79
 
80
- The training run uses RLCD-inspired weighted soft-target training from scratch,
81
- 20 epochs, approximately 15,640 optimizer steps, batch size 1024, bfloat16,
82
- learning rate `0.0002`, choice loss weight `8.0`, and score/noul weights `1.0`.
83
- The generator is identified as `neo-english-synthetic-v1` in the project
84
- manifests. The final benchmark report is produced after training and is not
85
- claimed by this card until verified.
86
 
87
  ## Tokenizer
88
 
89
- Neo uses the standard English `bert-base-uncased` tokenizer and vocabulary. A
90
- custom tokenizer was not built for this release, so no custom tokenizer is
91
- claimed or published under `tokenizer/`. The Transformer parameters are Neo's
92
- own randomly initialized and trained weights; the tokenizer vocabulary is not
93
- the model architecture.
94
 
95
  ## Release status
96
 
97
  The previous model weights were removed from this repository before the final
98
  English-only training release. The current repository contains documentation,
99
- configuration, tokenizer metadata, and licenses while the English training and
100
- automatic evaluation pipeline complete. Do not infer benchmark accuracy from
101
- the architecture or data counts. Verified results will be published only after
102
- the local evaluation artifacts are reviewed.
103
 
104
  ## Repository layout
105
 
@@ -107,12 +107,11 @@ the local evaluation artifacts are reviewed.
107
  - `licenses/NOTICE.md` β€” attribution and ownership notice.
108
  - `assets/neo-cover.png` β€” repository artwork.
109
  - `docs/MODEL_SPECIFICATION.md` β€” technical specification.
110
- - `tokenizer/` β€” reserved for a custom tokenizer only if one is actually built.
111
- - `training_config.json` β€” reproducibility metadata when a release includes it.
112
 
113
  ## License and attribution
114
 
115
- Use is governed by [the TokenAI Neo Model License v3.0](licenses/MODEL_LICENSE.md).
116
  Redistribution, renaming, rebranding, white-labeling, Derivative Models,
117
  Commercial Use, and Financial Benefit are prohibited without written permission
118
  from TokenAI. Every permitted downstream report or model must state:
 
1
  ---
2
  license: other
3
+ license_name: tokenai-neo-model-license
4
  license_link: https://huggingface.co/tokenaii/Neo/blob/main/licenses/MODEL_LICENSE.md
5
  library_name: pytorch
6
  pipeline_tag: text-classification
 
36
 
37
  Training dataset: `tokenaii/Neo-dataset` β€” https://huggingface.co/datasets/tokenaii/Neo-dataset
38
 
39
+ Complete source repository: [github.com/tokenaii/Neo](https://github.com/tokenaii/Neo).
40
+ It contains the complete project source code, training code, synthetic-data
41
+ generation code, evaluation and benchmark scripts, configurations, examples,
42
+ documentation, licenses, and reproducibility materials.
43
+
44
  ## Model architecture
45
 
46
  - Bidirectional Transformer encoder, initialized and trained from scratch.
 
75
  insurance, credit, safety-critical, government-benefit, law-enforcement, or
76
  irreversible decisions.
77
 
78
+ ## Training records
79
+
80
+ Training code, configurations, live logs, loss history, checkpoints metadata,
81
+ evaluation reports, and benchmark history are maintained only in the GitHub
82
+ source repository:
83
 
84
+ https://github.com/tokenaii/Neo/tree/main/docs/training
 
 
 
85
 
86
+ This Hugging Face model repository does not publish the training history or
87
+ benchmark archive.
 
 
 
 
88
 
89
  ## Tokenizer
90
 
91
+ Neo uses the standard English `bert-base-uncased` tokenizer and vocabulary,
92
+ published under `tokenizer/` for repository organization. A custom tokenizer
93
+ was not built. The Transformer parameters are Neo's own randomly initialized
94
+ and trained weights; the tokenizer vocabulary is not the model architecture.
 
95
 
96
  ## Release status
97
 
98
  The previous model weights were removed from this repository before the final
99
  English-only training release. The current repository contains documentation,
100
+ documentation, tokenizer metadata, and licenses. Do not infer benchmark
101
+ accuracy from the architecture or data counts. Training and benchmark records
102
+ are maintained only in the GitHub source repository.
 
103
 
104
  ## Repository layout
105
 
 
107
  - `licenses/NOTICE.md` β€” attribution and ownership notice.
108
  - `assets/neo-cover.png` β€” repository artwork.
109
  - `docs/MODEL_SPECIFICATION.md` β€” technical specification.
110
+ - `tokenizer/` β€” standard English `bert-base-uncased` tokenizer files.
 
111
 
112
  ## License and attribution
113
 
114
+ Use is governed by [the TokenAI Neo Model License](licenses/MODEL_LICENSE.md).
115
  Redistribution, renaming, rebranding, white-labeling, Derivative Models,
116
  Commercial Use, and Financial Benefit are prohibited without written permission
117
  from TokenAI. Every permitted downstream report or model must state: