Update README.md

README.md

@@ -11,7 +11,7 @@ pipeline_tag: translation
 
 # Model Card for Russian - Veps version 1.0
 
-A model of translation from Vepsian into Russian.
+A model of translation from Russian into Vepsian.
 In archive initial weights of the model trained with OpenNMT-py (Locomotive).
 The model has 457M parameters and is trained from scratch.
 Also presented are model weights converted for Ctranslate2 and a package for installation and use with Argostranslate/Libretranslate.
@@ -38,9 +38,40 @@ transformer_ff: 6144
 word_vec_size: 512
 ```
 
+# How to Use
+
+## Using the Model with OpenNMT-py
+
+To fine-tune the Russian to Vepsian translation model using [OpenNMT-py](https://github.com/OpenNMT/OpenNMT-py), you can modify and use the example configuration file from this repository - config.yml.
+
+
+## Using the Model with LibreTranslate and Argos Translate
+
+To use the Russian to Vepsian translation model with [LibreTranslate](https://github.com/LibreTranslate/LibreTranslate) and [Argos Translate](https://github.com/argosopentech/argos-translate), follow these steps:
+
+* Download the Model Archive: Ensure you have the `translate-ru_vep-1_0.argosmodel` file.
+* Locate the Packages Folder:
+  * On Linux/MacOS: `~/.local/share/argos-translate/packages`
+  * On Windows: `%userprofile%\.local\share\argos-translate\packages`
+* Create the Language Pair Folder:
+  * Create a folder named ru_vep in the packages directory. If it already exists, delete or move it.
+* Extract the Model Archive:
+  * Change the extension of the .argosmodel file to .zip.
+  * Extract the contents of the .zip file into the ru_vep folder.
+* Restart LibreTranslate:
+  * Restart the LibreTranslate application to load the new model.
+
+
+
 # Citing & Authors 
 
-Authors: Maksim Migukin, Maksim Kuznetsov, Alexey Kutashov.
+```
+@inproceedings{
+title={Model for Russian - Veps translation.},
+author={Maksim Migukin, Maksim Kuznetsov, Alexey Kutashov},
+year={2024}
+}
+```
 
 ## Credits