readme

.gitattributes

@@ -1,35 +0,0 @@
-*.7z filter=lfs diff=lfs merge=lfs -text
-*.arrow filter=lfs diff=lfs merge=lfs -text
-*.bin filter=lfs diff=lfs merge=lfs -text
-*.bz2 filter=lfs diff=lfs merge=lfs -text
-*.ckpt filter=lfs diff=lfs merge=lfs -text
-*.ftz filter=lfs diff=lfs merge=lfs -text
-*.gz filter=lfs diff=lfs merge=lfs -text
-*.h5 filter=lfs diff=lfs merge=lfs -text
-*.joblib filter=lfs diff=lfs merge=lfs -text
-*.lfs.* filter=lfs diff=lfs merge=lfs -text
-*.mlmodel filter=lfs diff=lfs merge=lfs -text
-*.model filter=lfs diff=lfs merge=lfs -text
-*.msgpack filter=lfs diff=lfs merge=lfs -text
-*.npy filter=lfs diff=lfs merge=lfs -text
-*.npz filter=lfs diff=lfs merge=lfs -text
-*.onnx filter=lfs diff=lfs merge=lfs -text
-*.ot filter=lfs diff=lfs merge=lfs -text
-*.parquet filter=lfs diff=lfs merge=lfs -text
-*.pb filter=lfs diff=lfs merge=lfs -text
-*.pickle filter=lfs diff=lfs merge=lfs -text
-*.pkl filter=lfs diff=lfs merge=lfs -text
-*.pt filter=lfs diff=lfs merge=lfs -text
-*.pth filter=lfs diff=lfs merge=lfs -text
-*.rar filter=lfs diff=lfs merge=lfs -text
-*.safetensors filter=lfs diff=lfs merge=lfs -text
-saved_model/**/* filter=lfs diff=lfs merge=lfs -text
-*.tar.* filter=lfs diff=lfs merge=lfs -text
-*.tar filter=lfs diff=lfs merge=lfs -text
-*.tflite filter=lfs diff=lfs merge=lfs -text
-*.tgz filter=lfs diff=lfs merge=lfs -text
-*.wasm filter=lfs diff=lfs merge=lfs -text
-*.xz filter=lfs diff=lfs merge=lfs -text
-*.zip filter=lfs diff=lfs merge=lfs -text
-*.zst filter=lfs diff=lfs merge=lfs -text
-*tfevents* filter=lfs diff=lfs merge=lfs -text

README.md

@@ -1,3 +1,119 @@
----
-license: apache-2.0
----
+---
+license: LICENSE
+language:
+- ES
+pipeline_tag: translation
+tags:
+- Translation
+- Capitalization-and-punctuation
+- Transformer
+---
+
+# HiTZ's Capitalization & Punctuation model for Spanish
+
+## Model description
+This model was trained from scratch usign Marian NMT. The dataset used in training contains 9,784,905 sentences. The model was evaluated on the Flores-101 dev and devtest datasets and some randomly picked CommonVoice dataset sentences.  
+* **Developed by**: HiTZ Research Center (University of the Basque Country EHU)
+* **Model type**: Capitalization and Punctuation
+* **Language**: Spanish  
+
+## Intended uses and limitations  
+You can use this model for Punctuation and Capitalization in Spanish  
+## Usage
+Required packages:
+- torch
+- transformers
+- sentencepiece
+
+### Capitalizing using python:
+Clone repository to download the model:
+
+```bash
+git clone https://huggingface.co/HiTZ/marianmt-cap-punct-es
+```
+
+Given `MODEL_PATH` is the path that points to the downloaded `marianmt-cap-punct-es` folder.
+
+```python
+from transformers import pipeline
+
+device = 0 # 0-->GPU, -1-->CPU
+
+segment_list = ["hola buenos días a todos", "faktoria se escucha en la radio de e i te be", "más o menos el cuarenta y dos por ciento","cuatro ocho quince dieciséis veintitrés cuarenta y dos","mi año de nacimiento es mil novecientos noventa y seis", "más información en uve doble uve doble uve doble punto e hache u punto eus"]
+
+translator = pipeline(task="translation", model=MODEL_PATH, tokenizer=MODEL_PATH, device=device)    
+result_list = translator(segment_list)
+cp_segment_list = [result["translation_text"] for result in result_list]
+
+for text, cp_text in zip(segment_list, cp_segment_list):
+    print(f"Normalized: {text}\n  With C&P: {cp_text}\n")
+```
+
+### Expected output:
+```bash
+Normalized: hola buenos días a todos
+  With C&P: Hola, buenos días a todos.
+
+Normalized: faktoria se escucha en la radio de e i te be
+  With C&P: Faktoria se escucha en la radio de EiTB
+
+Normalized: más o menos el cuarenta y dos por ciento
+  With C&P: Más o menos el 42 %.
+
+Normalized: cuatro ocho quince dieciséis veintitrés cuarenta y dos
+  With C&P: Cuatro, ocho, quince, dieciséis, veintitrés, cuarenta y dos.
+
+Normalized: mi año de nacimiento es mil novecientos noventa y seis
+  With C&P: Mi año de nacimiento es 1996.
+
+Normalized: más información en uve doble uve doble uve doble punto e hache u punto eus
+  With C&P: Más información en www.ehu.eus
+```
+
+## Training
+
+### Data preparation
+The training data was compiled by our research group from multiple heterogeneous sources and consists of approximately 9,784,905 sentences.
+
+Prior to training, the data underwent preprocessing steps including cleaning, punctuation standardization, filtering, and the creation of aligned input–output sentence pairs for the capitalization and punctuation restoration task.
+
+To generate the input–output pairs, the target sentences were lowercased, punctuation was removed, and text normalization was applied using an in-house normalization tool.
+  
+Example:  
+```bash 
+Output (Cleaned, filetered and standarized): Esto supone pasar de los 0,22 euros por elector de las Elecciones Generales de 2011 a 0,18 euros en las de 2015.  
+Input (Lowercased, without punctuation and normalized): esto supone pasar de los cero coma veintidos euros por elector de las elecciones generales de dos mil once a cero coma dieciocho euros en las de dos mil quince 
+```
+ 
+### Training procedure
+The model was trained using the official [MarianNMT](https://marian-nmt.github.io/quickstart/) implementation.  
+Training was performed on a single NVIDIA TITAN RTX GPU.
+
+## Performance
+The following table shows the model performance. We use the Word Error Rate metric. The WER-WITHOUT metric corresponds to the Word Error Rate computed on the evaluation dataset before applying capitalization and punctuation restoration. The WER metric corresponds to the output after processing with the model.
+The evaluation dataset underwent the same processing as the training dataset.  
+
+| Metric      | FLORES-101     | COMMON-VOICE   |
+|-------------|----------------|----------------|
+| WER-WITHOUT |       %19.55   |      %22.42    |
+|     WER     |        %5.99   |       %5.75    |
+
+
+# Aditional Information
+## Author
+HiTZ Basque Center for Language Technology - Aholab Signal Processing Laboratory, University of the Basque Country UPV/EHU.
+
+## Copyright
+Copyright (c) 2025 HiTZ Basque Center for Language Technology - Aholab Signal Processing Laboratory, University of the Basque Country UPV/EHU.
+
+## Licensing Information
+This work is licensed under a [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0)  
+
+## Disclaimer
+<details>
+<summary>Click to expand</summary>
+The models published in this repository are intended for a generalist purpose and are available to third parties. These models may have bias and/or any other undesirable distortions.
+
+When third parties, deploy or provide systems and/or services to other parties using any of these models (or using systems based on these models) or become users of the models, they should note that it is their responsibility to mitigate the risks arising from their use and, in any event, to comply with applicable regulations, including regulations regarding the use of Artificial Intelligence.
+
+In no event shall the owner and creator of the models (HiTZ Basque Center for Language Technology - Aholab Signal Processing Laboratory, University of the Basque Country UPV/EHU.) be liable for any results arising from the use made by third parties of these models.

config.json

@@ -1,39 +0,0 @@
-{
-  "activation_dropout": 0.0,
-  "activation_function": "swish",
-  "architectures": [
-    "MarianMTModel"
-  ],
-  "attention_dropout": 0.0,
-  "bos_token_id": 0,
-  "d_model": 512,
-  "decoder_attention_heads": 8,
-  "decoder_ffn_dim": 2048,
-  "decoder_layerdrop": 0.0,
-  "decoder_layers": 6,
-  "decoder_start_token_id": 32000,
-  "decoder_vocab_size": 32001,
-  "dropout": 0.1,
-  "dtype": "float32",
-  "encoder_attention_heads": 8,
-  "encoder_ffn_dim": 2048,
-  "encoder_layerdrop": 0.0,
-  "encoder_layers": 6,
-  "eos_token_id": 0,
-  "forced_eos_token_id": 0,
-  "init_std": 0.02,
-  "is_encoder_decoder": true,
-  "max_length": null,
-  "max_position_embeddings": 512,
-  "model_type": "marian",
-  "normalize_embedding": false,
-  "num_beams": null,
-  "num_hidden_layers": 6,
-  "pad_token_id": 32000,
-  "scale_embedding": true,
-  "share_encoder_decoder_embeddings": true,
-  "static_position_embeddings": true,
-  "transformers_version": "4.57.3",
-  "use_cache": true,
-  "vocab_size": 32001
-}

generation_config.json

@@ -1,16 +0,0 @@
-{
-  "_from_model_config": true,
-  "bad_words_ids": [
-    [
-      32000
-    ]
-  ],
-  "bos_token_id": 0,
-  "decoder_start_token_id": 32000,
-  "eos_token_id": 0,
-  "forced_eos_token_id": 0,
-  "max_length": 512,
-  "num_beams": 6,
-  "pad_token_id": 32000,
-  "transformers_version": "4.57.3"
-}

model.safetensors

@@ -1,3 +0,0 @@
-version https://git-lfs.github.com/spec/v1
-oid sha256:737d3828c9f1ca12e3f4103fcccd77e82b4ff0e63dfe3c15dfdbafb9f6bdc783
-size 242249092

special_tokens_map.json

@@ -1,23 +0,0 @@
-{
-  "eos_token": {
-    "content": "</s>",
-    "lstrip": false,
-    "normalized": false,
-    "rstrip": false,
-    "single_word": false
-  },
-  "pad_token": {
-    "content": "<pad>",
-    "lstrip": false,
-    "normalized": false,
-    "rstrip": false,
-    "single_word": false
-  },
-  "unk_token": {
-    "content": "<unk>",
-    "lstrip": false,
-    "normalized": false,
-    "rstrip": false,
-    "single_word": false
-  }
-}

tokenizer_config.json

@@ -1,39 +0,0 @@
-{
-  "added_tokens_decoder": {
-    "0": {
-      "content": "</s>",
-      "lstrip": false,
-      "normalized": false,
-      "rstrip": false,
-      "single_word": false,
-      "special": true
-    },
-    "1": {
-      "content": "<unk>",
-      "lstrip": false,
-      "normalized": false,
-      "rstrip": false,
-      "single_word": false,
-      "special": true
-    },
-    "32000": {
-      "content": "<pad>",
-      "lstrip": false,
-      "normalized": false,
-      "rstrip": false,
-      "single_word": false,
-      "special": true
-    }
-  },
-  "clean_up_tokenization_spaces": false,
-  "eos_token": "</s>",
-  "extra_special_tokens": {},
-  "model_max_length": 512,
-  "pad_token": "<pad>",
-  "separate_vocabs": false,
-  "source_lang": "",
-  "sp_model_kwargs": {},
-  "target_lang": "modelCastellano",
-  "tokenizer_class": "MarianTokenizer",
-  "unk_token": "<unk>"
-}