Upload processor

README.md

@@ -0,0 +1,199 @@
+---
+library_name: transformers
+tags: []
+---
+
+# Model Card for Model ID
+
+<!-- Provide a quick summary of what the model is/does. -->
+
+
+
+## Model Details
+
+### Model Description
+
+<!-- Provide a longer summary of what this model is. -->
+
+This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
+
+- **Developed by:** [More Information Needed]
+- **Funded by [optional]:** [More Information Needed]
+- **Shared by [optional]:** [More Information Needed]
+- **Model type:** [More Information Needed]
+- **Language(s) (NLP):** [More Information Needed]
+- **License:** [More Information Needed]
+- **Finetuned from model [optional]:** [More Information Needed]
+
+### Model Sources [optional]
+
+<!-- Provide the basic links for the model. -->
+
+- **Repository:** [More Information Needed]
+- **Paper [optional]:** [More Information Needed]
+- **Demo [optional]:** [More Information Needed]
+
+## Uses
+
+<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
+
+### Direct Use
+
+<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
+
+[More Information Needed]
+
+### Downstream Use [optional]
+
+<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
+
+[More Information Needed]
+
+### Out-of-Scope Use
+
+<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
+
+[More Information Needed]
+
+## Bias, Risks, and Limitations
+
+<!-- This section is meant to convey both technical and sociotechnical limitations. -->
+
+[More Information Needed]
+
+### Recommendations
+
+<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+
+Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
+
+## How to Get Started with the Model
+
+Use the code below to get started with the model.
+
+[More Information Needed]
+
+## Training Details
+
+### Training Data
+
+<!-- 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. -->
+
+[More Information Needed]
+
+### Training Procedure
+
+<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
+
+#### Preprocessing [optional]
+
+[More Information Needed]
+
+
+#### Training Hyperparameters
+
+- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
+
+#### Speeds, Sizes, Times [optional]
+
+<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
+
+[More Information Needed]
+
+## Evaluation
+
+<!-- This section describes the evaluation protocols and provides the results. -->
+
+### Testing Data, Factors & Metrics
+
+#### Testing Data
+
+<!-- This should link to a Dataset Card if possible. -->
+
+[More Information Needed]
+
+#### Factors
+
+<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
+
+[More Information Needed]
+
+#### Metrics
+
+<!-- These are the evaluation metrics being used, ideally with a description of why. -->
+
+[More Information Needed]
+
+### Results
+
+[More Information Needed]
+
+#### Summary
+
+
+
+## Model Examination [optional]
+
+<!-- Relevant interpretability work for the model goes here -->
+
+[More Information Needed]
+
+## Environmental Impact
+
+<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
+
+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).
+
+- **Hardware Type:** [More Information Needed]
+- **Hours used:** [More Information Needed]
+- **Cloud Provider:** [More Information Needed]
+- **Compute Region:** [More Information Needed]
+- **Carbon Emitted:** [More Information Needed]
+
+## Technical Specifications [optional]
+
+### Model Architecture and Objective
+
+[More Information Needed]
+
+### Compute Infrastructure
+
+[More Information Needed]
+
+#### Hardware
+
+[More Information Needed]
+
+#### Software
+
+[More Information Needed]
+
+## Citation [optional]
+
+<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
+
+**BibTeX:**
+
+[More Information Needed]
+
+**APA:**
+
+[More Information Needed]
+
+## Glossary [optional]
+
+<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
+
+[More Information Needed]
+
+## More Information [optional]
+
+[More Information Needed]
+
+## Model Card Authors [optional]
+
+[More Information Needed]
+
+## Model Card Contact
+
+[More Information Needed]

chat_template.jinja

@@ -1,5 +1,75 @@
-{% set loop_total = messages|length %}{% for message in messages %}{% if loop.first %}<|begin_of_text|>{% endif %}<|start_header_id|>{{ message['role'] }}<|end_header_id|>
+{{- bos_token }}
 
-{% if message.get('recipient') and message['role'] == 'assistant' %}{{ message['recipient'] }}<|recipient|>{% endif %}{% if message['content'] is string %}{{ message['content'] }}{% else %}{% for content in message['content'] %}{% if content['type'] == 'text' %}{{ content['text'] }}{% elif content['type'] == 'audio' %}{% if message['role'] in ['user', 'system'] %}<|audio_bos|><|AUDIO|><|audio_eos|>{% elif message['role'] == 'assistant' %}<|audio_out_bos|><|AUDIO_OUT|><|audio_eos|>{% endif %}{% endif %}{% endfor %}{% endif %}{% set next_idx = loop.index %}{% if message['role'] == 'assistant' and next_idx < loop_total and messages[next_idx]['role'] == 'assistant' %}<|eom_id|>{% else %}<|eot_id|>{% endif %}{% endfor %}{% if add_generation_prompt %}<|start_header_id|>assistant<|end_header_id|>
+{#- This block extracts the system message, so we can slot it into the right place. #}
+{%- if messages[0]['role'] == 'system' %}
+    {%- if messages[0]['content'] is string %}
+        {%- set system_message = messages[0]['content']|trim %}
+    {%- elif messages[0]['content'] is iterable and messages[0]['content'][0]['type'] == 'text' %}
+        {%- set system_message = messages[0]['content'][0]['text']|trim %}
+    {%- else %}
+        {{- raise_exception("System message content must be a string or contain text type!") }}
+    {%- endif %}
+    {%- set messages = messages[1:] %}
+{%- else %}
+    {{- raise_exception("A system message is required but not provided!") }}
+{%- endif %}
 
-{% endif %}
+{#- System message #}
+{{- "<|start_header_id|>system<|end_header_id|>\n\n" }}
+{{- system_message }}
+
+{#- Check for scene message and handle it specially #}
+{%- if messages and messages[0]['role'] == 'scene' %}
+    {{- "\n\n<|scene_desc_start|>\n" }}
+    {%- if messages[0]['content'] is string %}
+        {{- messages[0]['content'] | trim }}
+    {%- elif messages[0]['content'] is iterable %}
+        {%- for content_item in messages[0]['content'] %}
+            {%- if content_item['type'] == 'text' %}
+                {%- set text_content = content_item['text'] | trim %}
+                {{- text_content }}
+                {%- if loop.first and not loop.last %}
+                    {{- "\n\n" }}            
+                {%- endif %}
+                {%- if not loop.first and not loop.last and messages[0]['content'][loop.index]['type'] != 'audio' %}
+                    {{- "\n" }}
+                {%- endif %}
+            {%- elif content_item['type'] == 'audio' %}
+                {{- ' <|audio_bos|><|AUDIO|><|audio_eos|>' }}
+                {%- if not loop.last %}
+                    {{- "\n" }}
+                {%- endif %}
+            {%- endif %}
+        {%- endfor %}
+    {%- endif %}
+    {{- "\n<|scene_desc_end|>" }}
+    {%- set messages = messages[1:] %}
+{%- endif %}
+
+{{- "<|eot_id|>" }}
+
+{#- Loop through all messages #}
+{%- for message in messages %}
+    {{- '<|start_header_id|>' + message['role'] + '<|end_header_id|>\n\n' }}
+    {%- if message['role'] == 'assistant' %}
+        {%- if message['content'] is not iterable or message['content'][0]['type'] != 'audio' %}
+            {{- raise_exception("Assistant messages must contain audio content only!") }}
+        {%- endif %}
+        {{- '<|audio_bos|><|AUDIO|><|audio_eos|>' }}
+    {%- else %}
+        {%- if message['content'] is string %}
+            {{- message['content'] | trim }}
+        {%- elif message['content'] is iterable %}
+            {%- for content_item in message['content'] %}
+                {%- if content_item['type'] == 'text' %}
+                    {{- content_item['text'] | trim }}
+                {%- endif %}
+            {%- endfor %}
+        {%- endif %}
+    {%- endif %}
+    {{- '<|eot_id|>' }}
+{%- endfor %}
+
+{%- if add_generation_prompt %}
+    {{- '<|start_header_id|>assistant<|end_header_id|>' }}
+{%- endif %}

processor_config.json

@@ -0,0 +1,6 @@
+{
+  "audio_bos_token": "<|audio_bos|>",
+  "audio_eos_token": "<|audio_eos|>",
+  "audio_token": "<|AUDIO|>",
+  "processor_class": "HiggsAudioProcessor"
+}