Lynxpda commited on
Commit
135a524
1 Parent(s): 304dc8a

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +30 -1
README.md CHANGED
@@ -37,10 +37,39 @@ tgt_vocab_size: 32000
37
  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
 
 
37
  transformer_ff: 6144
38
  word_vec_size: 512
39
  ```
40
+ # How to Use
41
+
42
+ ## Using the Model with OpenNMT-py
43
+
44
+ To fine-tune the Vepsian to Russian 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.
45
+
46
+
47
+ ## Using the Model with LibreTranslate and Argos Translate
48
+
49
+ To use the Vepsian to Russian translation model with [LibreTranslate](https://github.com/LibreTranslate/LibreTranslate) and [Argos Translate](https://github.com/argosopentech/argos-translate), follow these steps:
50
+
51
+ * Download the Model Archive: Ensure you have the `translate-vep_ru-1_0.argosmodel` file.
52
+ * Locate the Packages Folder:
53
+ * On Linux/MacOS: `~/.local/share/argos-translate/packages`
54
+ * On Windows: `%userprofile%\.local\share\argos-translate\packages`
55
+ * Create the Language Pair Folder:
56
+ * Create a folder named vep_ru in the packages directory. If it already exists, delete or move it.
57
+ * Extract the Model Archive:
58
+ * Change the extension of the .argosmodel file to .zip.
59
+ * Extract the contents of the .zip file into the vep_ru folder.
60
+ * Restart LibreTranslate:
61
+ * Restart the LibreTranslate application to load the new model.
62
+
63
 
64
  # Citing & Authors
65
 
66
+ ```
67
+ @inproceedings{
68
+ title={Model for Veps - Russian translation.},
69
+ author={Maksim Migukin, Maksim Kuznetsov, Alexey Kutashov},
70
+ year={2024}
71
+ }
72
+ ```
73
 
74
  ## Credits
75