Lynxpda commited on
Commit
adf15c3
1 Parent(s): 1eb09b1

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +33 -2
README.md CHANGED
@@ -11,7 +11,7 @@ pipeline_tag: translation
11
 
12
  # Model Card for Russian - Veps version 1.0
13
 
14
- A model of translation from Vepsian into Russian.
15
  In archive initial weights of the model trained with OpenNMT-py (Locomotive).
16
  The model has 457M parameters and is trained from scratch.
17
  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
38
  word_vec_size: 512
39
  ```
40
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
41
  # Citing & Authors
42
 
43
- Authors: Maksim Migukin, Maksim Kuznetsov, Alexey Kutashov.
 
 
 
 
 
 
44
 
45
  ## Credits
46
 
 
11
 
12
  # Model Card for Russian - Veps version 1.0
13
 
14
+ A model of translation from Russian into Vepsian.
15
  In archive initial weights of the model trained with OpenNMT-py (Locomotive).
16
  The model has 457M parameters and is trained from scratch.
17
  Also presented are model weights converted for Ctranslate2 and a package for installation and use with Argostranslate/Libretranslate.
 
38
  word_vec_size: 512
39
  ```
40
 
41
+ # How to Use
42
+
43
+ ## Using the Model with OpenNMT-py
44
+
45
+ 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.
46
+
47
+
48
+ ## Using the Model with LibreTranslate and Argos Translate
49
+
50
+ 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:
51
+
52
+ * Download the Model Archive: Ensure you have the `translate-ru_vep-1_0.argosmodel` file.
53
+ * Locate the Packages Folder:
54
+ * On Linux/MacOS: `~/.local/share/argos-translate/packages`
55
+ * On Windows: `%userprofile%\.local\share\argos-translate\packages`
56
+ * Create the Language Pair Folder:
57
+ * Create a folder named ru_vep in the packages directory. If it already exists, delete or move it.
58
+ * Extract the Model Archive:
59
+ * Change the extension of the .argosmodel file to .zip.
60
+ * Extract the contents of the .zip file into the ru_vep folder.
61
+ * Restart LibreTranslate:
62
+ * Restart the LibreTranslate application to load the new model.
63
+
64
+
65
+
66
  # Citing & Authors
67
 
68
+ ```
69
+ @inproceedings{
70
+ title={Model for Russian - Veps translation.},
71
+ author={Maksim Migukin, Maksim Kuznetsov, Alexey Kutashov},
72
+ year={2024}
73
+ }
74
+ ```
75
 
76
  ## Credits
77