calbors commited on
Commit
1bbf301
·
verified ·
1 Parent(s): 93e8fd4

Upload model

Browse files
Files changed (4) hide show
  1. README.md +199 -0
  2. config.json +14 -0
  3. minimal_hub_utils.py +164 -0
  4. model.safetensors +3 -0
README.md ADDED
@@ -0,0 +1,199 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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]
config.json ADDED
@@ -0,0 +1,14 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ {
2
+ "architectures": [
3
+ "Model"
4
+ ],
5
+ "auto_map": {
6
+ "AutoConfig": "minimal_hub_utils.Config",
7
+ "AutoModel": "minimal_hub_utils.Model"
8
+ },
9
+ "input_dim": 4,
10
+ "model_type": "dummy",
11
+ "output_dim": 2,
12
+ "torch_dtype": "float32",
13
+ "transformers_version": "4.51.3"
14
+ }
minimal_hub_utils.py ADDED
@@ -0,0 +1,164 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ from __future__ import annotations
2
+ from pathlib import Path
3
+ from torch import nn
4
+ from transformers import AutoConfig, AutoModel, AutoTokenizer
5
+ from transformers import PretrainedConfig, PreTrainedModel, PreTrainedTokenizer
6
+
7
+ def make_config_class(model_args: dict, model_type: str) -> type[PretrainedConfig]:
8
+ model_type_ = model_type
9
+
10
+ class Config(PretrainedConfig):
11
+ model_type = model_type_
12
+
13
+ def __init__(self, **kwargs):
14
+ for k, v in model_args.items():
15
+ setattr(self, k, kwargs.get(k, v))
16
+
17
+ super().__init__(**kwargs)
18
+
19
+ return Config
20
+
21
+
22
+ def make_model_class(base_class: type[nn.Module]) -> type[PreTrainedModel]:
23
+ class Model(PreTrainedModel):
24
+ config_class: type[PretrainedConfig]
25
+
26
+ def __init__(self, config: PretrainedConfig, *args, **kwargs):
27
+ super().__init__(config)
28
+ self._model = base_class(config, *args, **kwargs)
29
+
30
+ def forward(self, *args, **kwargs):
31
+ return self._model(*args, **kwargs)
32
+
33
+ return Model
34
+
35
+
36
+ def make_tokenizer_class(
37
+ vocab: list[str],
38
+ special_tokens: dict[str, str]
39
+ ) -> type[PreTrainedTokenizer]:
40
+
41
+ for key in special_tokens:
42
+ if key not in ["unk", "pad", "bos", "eos", "sep", "cls", "mask"]:
43
+ raise ValueError(f"unrecognized special token key: `{key}`")
44
+
45
+ unk_token = special_tokens.get("unk", vocab[0])
46
+ token_to_idx = {k: v for v, k in enumerate(vocab)}
47
+ idx_to_token = {v: k for k, v in token_to_idx.items()}
48
+
49
+ # I have no idea how this class works, I copied from somewhere else and forgot
50
+ class Tokenizer(PreTrainedTokenizer):
51
+ model_input_names = ["input_ids"]
52
+
53
+ def __init__(
54
+ self,
55
+ model_max_length: int | None = None,
56
+ split_special_tokens: bool = True,
57
+ **kwargs
58
+ ):
59
+ self.model_max_length = model_max_length
60
+ self._vocab = token_to_idx
61
+ self._inv_vocab = idx_to_token
62
+ tokens = dict(
63
+ unk_token=special_tokens.get("unk"),
64
+ pad_token=special_tokens.get("pad"),
65
+ bos_token=special_tokens.get("bos"),
66
+ eos_token=special_tokens.get("eos"),
67
+ sep_token=special_tokens.get("sep"),
68
+ cls_token=special_tokens.get("cls"),
69
+ mask_token=special_tokens.get("mask"),
70
+ )
71
+ tokens = {k: v for k, v in tokens.items() if v is not None}
72
+ super().__init__(
73
+ model_max_length=model_max_length,
74
+ split_special_tokens=split_special_tokens,
75
+ **tokens,
76
+ **kwargs,
77
+ )
78
+
79
+ def _tokenize(self, seq: str) -> list[str]:
80
+ return list(seq)
81
+
82
+ def _convert_token_to_id(self, token: str) -> int:
83
+ return self._vocab.get(token, self._vocab[unk_token])
84
+
85
+ def _convert_id_to_token(self, idx: int) -> str:
86
+ return self._inv_vocab[idx]
87
+
88
+ @property
89
+ def vocab_size(self) -> int:
90
+ return len(self._vocab)
91
+
92
+ def get_vocab(self) -> dict[str, int]:
93
+ return self._vocab
94
+
95
+ def save_vocabulary(self, save_directory: str, filename_prefix: str | None = None) -> tuple:
96
+ return ()
97
+
98
+ return Tokenizer
99
+
100
+
101
+ def register_auto_classes(
102
+ config_class: type[PretrainedConfig],
103
+ model_class: type[PreTrainedModel] = None,
104
+ tokenizer_class: type[PreTrainedTokenizer] = None,
105
+ force_registration: bool = False,
106
+ ):
107
+ model_type = getattr(config_class, "model_type", None)
108
+ if model_type is None:
109
+ raise ValueError("`config_class` must have a `model_type` attribute")
110
+
111
+ # Check if already registered
112
+ already_registered = check_auto_class_registered(
113
+ *(c for c in [config_class, model_class, tokenizer_class] if c is not None)
114
+ )
115
+ if already_registered and not force_registration:
116
+ raise RuntimeError("One or more classes are already registered. Set `force_registration=True` to override.")
117
+
118
+ AutoConfig.register(model_type, config_class)
119
+ config_class.register_for_auto_class()
120
+
121
+ if model_class is not None:
122
+ if not hasattr(model_class, "config_class") or model_class.config_class is None:
123
+ model_class.config_class = config_class
124
+
125
+ AutoModel.register(config_class, model_class)
126
+ model_class.register_for_auto_class("AutoModel")
127
+
128
+ if tokenizer_class is not None:
129
+ AutoTokenizer.register(config_class, tokenizer_class)
130
+ tokenizer_class.register_for_auto_class("AutoTokenizer")
131
+
132
+
133
+ def check_auto_class_registered(*classes) -> bool:
134
+ # Simple check: just return False to always allow registration
135
+ # This avoids complex version-dependent internal API checks
136
+ return False
137
+
138
+
139
+ def push_model_to_hub(
140
+ config_class: type[PretrainedConfig],
141
+ model_class: type[PreTrainedModel],
142
+ model_args: dict,
143
+ state_dict: dict,
144
+ id_: str,
145
+ commit_message: str = "Upload model",
146
+ ) -> str:
147
+ config = config_class(**model_args)
148
+ huggingface_model = model_class(config)
149
+ pytorch_model = getattr(huggingface_model, "_model")
150
+ pytorch_model.load_state_dict(state_dict)
151
+ config.save_pretrained(id_)
152
+ huggingface_model.save_pretrained(id_)
153
+ return huggingface_model.push_to_hub(id_, commit_message=commit_message)
154
+
155
+
156
+ def push_tokenizer_to_hub(
157
+ tokenizer_class: type[PreTrainedTokenizer],
158
+ id_: str,
159
+ commit_message: str = "Upload tokenizer",
160
+ **kwargs,
161
+ ) -> str:
162
+ tokenizer = tokenizer_class(**kwargs)
163
+ tokenizer.save_pretrained(id_)
164
+ return tokenizer.push_to_hub(id_, commit_message=commit_message)
model.safetensors ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:bebf415bc71c24ea6e3c1d28695ec58ffe1742a58b371640c8b821a13ab1b396
3
+ size 232