Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/marian-nmt/marian-examples.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRoman Grundkiewicz <rgrundkiewicz@gmail.com>2022-02-08 16:56:36 +0300
committerGitHub <noreply@github.com>2022-02-08 16:56:36 +0300
commit299123b00005d71867d4dde52e5e8f806b1caef4 (patch)
tree24c9d81b22dbc707a18a876b0f3cc29449538dc6
parent6d5921cc7de91f4e915b59e9c52c9a76c4e99b00 (diff)
parentb6915b66da2d06956a52886102d46d68864d03e2 (diff)
Merge pull request #24 from graemenail/master
Add `marian-example-library`
-rw-r--r--.gitmodules4
-rw-r--r--README.md24
m---------example-library0
3 files changed, 18 insertions, 10 deletions
diff --git a/.gitmodules b/.gitmodules
new file mode 100644
index 0000000..3ddbd40
--- /dev/null
+++ b/.gitmodules
@@ -0,0 +1,4 @@
+[submodule "example-library"]
+ path = example-library
+ url = https://github.com/marian-nmt/marian-example-library
+ branch = main
diff --git a/README.md b/README.md
index dc42b1c..14a0768 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@ Examples, tutorials and use cases for the Marian toolkit.
More information on https://marian-nmt.github.io
-List of examples:
+## Examples
* `translating-amun` -- examples for translating with Amun
* `training-basics` -- the complete example for training a WMT16-scale model
* `training-basics-sentencepiece` -- as `training-basics`, but uses built-in SentencePiece for data processing, requires Marian v1.7+
@@ -12,21 +12,26 @@ List of examples:
* `wmt2017-uedin` -- scripts for building a WMT2017-grade model for en-de based on Edinburgh's WMT2017 submission
* `wmt2017-transformer` -- scripts for building a better than WMT2017-grade model for en-de, beating WMT2017 submission by 1.2 BLEU
-## Usage
+### Usage
First download common tools:
-
- cd tools
- make all
- cd ..
+```shell
+cd tools
+make all
+cd ..
+```
Next, go to the chosen directory and run `run-me.sh`, e.g.:
-
- cd training-basics
- ./run-me.sh
+```shell
+cd training-basics
+./run-me.sh
+```
The README file in each directory provides more detailed description.
+## Templates
+* `example-library` -- example using Marian as a library demonstrating basic graph operations, available as a repository [template](https://github.com/marian-nmt/marian-example-library/generate)
+
## Acknowledgements
The development of Marian received funding from the European Union's
@@ -39,4 +44,3 @@ the Amazon Academic Research Awards program, and
the World Intellectual Property Organization.
This software contains source code provided by NVIDIA Corporation.
-
diff --git a/example-library b/example-library
new file mode 160000
+Subproject a33ef1055cbb3b7a8003138e9669d406a7bde42