ash3241 commited on
Commit
78d6442
·
verified ·
1 Parent(s): 789c81b

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +66 -193
README.md CHANGED
@@ -1,199 +1,72 @@
1
  ---
2
- library_name: transformers
3
- tags: []
 
 
 
 
 
4
  ---
5
 
6
- # Model Card for Model ID
7
-
8
- <!-- Provide a quick summary of what the model is/does. -->
9
-
10
 
 
11
 
12
  ## Model Details
13
-
14
- ### Model Description
15
-
16
- <!-- Provide a longer summary of what this model is. -->
17
-
18
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
19
-
20
- - **Developed by:** [More Information Needed]
21
- - **Funded by [optional]:** [More Information Needed]
22
- - **Shared by [optional]:** [More Information Needed]
23
- - **Model type:** [More Information Needed]
24
- - **Language(s) (NLP):** [More Information Needed]
25
- - **License:** [More Information Needed]
26
- - **Finetuned from model [optional]:** [More Information Needed]
27
-
28
- ### Model Sources [optional]
29
-
30
- <!-- Provide the basic links for the model. -->
31
-
32
- - **Repository:** [More Information Needed]
33
- - **Paper [optional]:** [More Information Needed]
34
- - **Demo [optional]:** [More Information Needed]
35
-
36
- ## Uses
37
-
38
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
39
-
40
- ### Direct Use
41
-
42
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
43
-
44
- [More Information Needed]
45
-
46
- ### Downstream Use [optional]
47
-
48
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
49
-
50
- [More Information Needed]
51
-
52
- ### Out-of-Scope Use
53
-
54
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
55
-
56
- [More Information Needed]
57
-
58
- ## Bias, Risks, and Limitations
59
-
60
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
61
-
62
- [More Information Needed]
63
-
64
- ### Recommendations
65
-
66
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
67
-
68
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
69
-
70
- ## How to Get Started with the Model
71
-
72
- Use the code below to get started with the model.
73
-
74
- [More Information Needed]
75
-
76
- ## Training Details
77
-
78
- ### Training Data
79
-
80
- <!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
81
-
82
- [More Information Needed]
83
-
84
- ### Training Procedure
85
-
86
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
87
-
88
- #### Preprocessing [optional]
89
-
90
- [More Information Needed]
91
-
92
-
93
- #### Training Hyperparameters
94
-
95
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
96
-
97
- #### Speeds, Sizes, Times [optional]
98
-
99
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
100
-
101
- [More Information Needed]
102
-
103
- ## Evaluation
104
-
105
- <!-- This section describes the evaluation protocols and provides the results. -->
106
-
107
- ### Testing Data, Factors & Metrics
108
-
109
- #### Testing Data
110
-
111
- <!-- This should link to a Dataset Card if possible. -->
112
-
113
- [More Information Needed]
114
-
115
- #### Factors
116
-
117
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
118
-
119
- [More Information Needed]
120
-
121
- #### Metrics
122
-
123
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
124
-
125
- [More Information Needed]
126
-
127
- ### Results
128
-
129
- [More Information Needed]
130
-
131
- #### Summary
132
-
133
-
134
-
135
- ## Model Examination [optional]
136
-
137
- <!-- Relevant interpretability work for the model goes here -->
138
-
139
- [More Information Needed]
140
-
141
- ## Environmental Impact
142
-
143
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
144
-
145
- Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
146
-
147
- - **Hardware Type:** [More Information Needed]
148
- - **Hours used:** [More Information Needed]
149
- - **Cloud Provider:** [More Information Needed]
150
- - **Compute Region:** [More Information Needed]
151
- - **Carbon Emitted:** [More Information Needed]
152
-
153
- ## Technical Specifications [optional]
154
-
155
- ### Model Architecture and Objective
156
-
157
- [More Information Needed]
158
-
159
- ### Compute Infrastructure
160
-
161
- [More Information Needed]
162
-
163
- #### Hardware
164
-
165
- [More Information Needed]
166
-
167
- #### Software
168
-
169
- [More Information Needed]
170
-
171
- ## Citation [optional]
172
-
173
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
174
-
175
- **BibTeX:**
176
-
177
- [More Information Needed]
178
-
179
- **APA:**
180
-
181
- [More Information Needed]
182
-
183
- ## Glossary [optional]
184
-
185
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
186
-
187
- [More Information Needed]
188
-
189
- ## More Information [optional]
190
-
191
- [More Information Needed]
192
-
193
- ## Model Card Authors [optional]
194
-
195
- [More Information Needed]
196
-
197
- ## Model Card Contact
198
-
199
- [More Information Needed]
 
1
  ---
2
+ license: mit
3
+ language:
4
+ - en
5
+ tags:
6
+ - tokenization
7
+ - custom-architecture
8
+ - experimental
9
  ---
10
 
11
+ # Continuous Amplitude Tokenization (CAT) - Toy Model
 
 
 
12
 
13
+ This repository contains the trained weights and vocabulary for a proof-of-concept toy model utilizing the novel **Continuous Amplitude Tokenization (CAT)** architecture.
14
 
15
  ## Model Details
16
+ Traditional LLMs rely on discrete BPE tokenization, forcing them to treat intensity modifiers ("very", "extremely", "slightly") as independent, arbitrary tokens. The CAT architecture splits language into two streams:
17
+ 1. **Concept ID (Discrete):** e.g., "bad", "large".
18
+ 2. **Amplitude (Continuous):** e.g., `1.0`, `2.0`, `5.0`.
19
+
20
+ This toy model processes sentences like *"The food was incredibly bad"* as a single compressed token mapping: `[Concept: "bad", Amplitude: 4.0]`, completely eliminating the need for combinatorial adjective tokens and physically shortening sequence lengths.
21
+
22
+ * **Architecture:** Custom Dual-Stream Causal Transformer (CAT)
23
+ * **Key Components:** Fourier-FiLM Embeddings, AP-RMSNorm, 4-way Bilinear Attention, Spatio-Amplitude RoPE.
24
+ * **Parameters:** ~4.6 Million
25
+ * **Vocabulary Size:** 15,000 words (Modifiers deleted and replaced by continuous scalars)
26
+ * **Dataset:** 15 Million tokens (Yelp Polarity Reviews)
27
+ * **Training Iterations:** 1,000 (Early-stage viability test)
28
+
29
+ ## Empirical Benefits
30
+ During benchmarking against a standard NanoGPT model on the exact same text, this CAT model achieved:
31
+ * **20% KV Cache Memory Savings** (due to reduced sequence lengths).
32
+ * **Vocab Compression** (by removing standard modifiers from the dictionary).
33
+ * **Zero-Shot Controllability** (ability to manually inject `Amplitude: 10.0` to force intensity scaling during generation).
34
+
35
+ ## Usage
36
+ To use these weights, you must use the custom CAT Model code from the official GitHub repository.
37
+
38
+ 1. **Clone the architecture:**
39
+ ```bash
40
+ git clone https://github.com/Yash943/CAT-Concept-Amplitude-Tokenization-.git
41
+ cd CAT-Concept-Amplitude-Tokenization-
42
+ pip install -e .
43
+ ```
44
+
45
+ 2. **Load the model (PyTorch):**
46
+ ```python
47
+ import torch
48
+ from cat.model import CATModel, CATConfig
49
+ from huggingface_hub import hf_hub_download
50
+
51
+ # Initialize the architecture
52
+ config = CATConfig(
53
+ vocab_size=15000,
54
+ hidden_size=128,
55
+ num_hidden_layers=4,
56
+ num_attention_heads=4,
57
+ intermediate_size=512,
58
+ max_position_embeddings=64
59
+ )
60
+ model = CATModel(config)
61
+
62
+ # Load the weights
63
+ weights_path = hf_hub_download(repo_id="your-repo-id/here", filename="cat_toy_model.pt")
64
+ model.load_state_dict(torch.load(weights_path))
65
+ print("CAT Model loaded successfully!")
66
+ ```
67
+
68
+ ## Intended Use
69
+ This is an experimental "toy" model designed strictly to prove the mathematical viability of Fourier-FiLM embeddings and AP-RMSNorm at reducing token fertility. It is not intended for production chat or generation tasks.
70
+
71
+ ## GitHub Repository
72
+ For full mathematical breakdowns, empirical verification scripts, and architectural source code, visit the [official GitHub repository](https://github.com/Yash943/CAT-Concept-Amplitude-Tokenization-).