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

github.com/marian-nmt/marian.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarcin Junczys-Dowmunt <junczys@amu.edu.pl>2018-09-16 12:56:46 +0300
committerGitHub <noreply@github.com>2018-09-16 12:56:46 +0300
commit46b0232339ef13efc06b3458facb2cba831411cc (patch)
tree5af6baf7d1c13e7fd906cbdd2f2a3b255ab331c0
parent5a42fdd3e6776ebbe464174620f37be781a2bff1 (diff)
Update README to reflect main repostable
-rw-r--r--README.md78
1 files changed, 53 insertions, 25 deletions
diff --git a/README.md b/README.md
index ad0aa810..150fd5d8 100644
--- a/README.md
+++ b/README.md
@@ -1,22 +1,55 @@
Marian
======
-[![Join the chat at https://gitter.im/marian-nmt](https://badges.gitter.im/amunmt/marian.svg)](https://gitter.im/marian-nmt?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-[![Build Status](http://vali.inf.ed.ac.uk/jenkins/buildStatus/icon?job=marian-dev)](http://vali.inf.ed.ac.uk/jenkins/job/marian-dev/)
-[![CPU Build Status](http://vali.inf.ed.ac.uk/jenkins/buildStatus/icon?job=marian-dev)](http://vali.inf.ed.ac.uk/jenkins/job/marian-dev-cpu/)
-[![Tests Status](http://vali.inf.ed.ac.uk/jenkins/buildStatus/icon?job=marian-regression-tests)](http://vali.inf.ed.ac.uk/jenkins/job/marian-regression-tests/)
-[![Twitter](https://img.shields.io/twitter/follow/marian_nmt.svg?style=social&label=Follow)](https://twitter.com/intent/follow?screen_name=marian_nmt)
-
-**Marian** is a C++ GPU-specific parallel automatic differentiation library
-with operator overloading. It is the training framework used in the Marian
-toolkit. This repository is the development repo of
-https://github.com/marian-nmt/marian, use it at your own risk.
-
-https://github.com/marian-nmt/marian is updated with stable versions of this
-repository.
-
-Named in honour of Marian Rejewski, a Polish mathematician and cryptologist.
-
+ <p>
+ <b>Marian</b> (formerly known as AmuNMT) is an efficient Neural Machine Translation framework written
+ in pure C++ with minimal dependencies. Named in honour of Marian Rejewski, a Polish mathematician and cryptologist.
+
+ Named in honour of Marian Rejewski, a Polish mathematician and cryptologist.
+
+ <!--It has mainly been developed at the
+ Adam Mickiewicz University in Poznań (AMU) and at the University of Edinburgh.-->
+ </p>
+
+ <!--p>
+ It is currently being deployed in
+ multiple European projects and is the main translation and training engine
+ behind the neural MT launch at the
+ <a href="http://www.wipo.int/pressroom/en/articles/2016/article_0014.html">World Intellectual Property Organization</a>.
+ </p-->
+
+ <p>
+ Main features:
+ <ul>
+ <li> Fast multi-gpu training and translation </li>
+ <li> Compatible with Nematus and DL4MT </li>
+ <li> Efficient pure C++ implementation </li>
+ <li> Permissive open source license (MIT) </li>
+ <li> <a href="https://marian-nmt.github.io/features/"> more details... </a> </li>
+ </ul>
+ </p>
+
+If you use this, please cite:
+
+Marcin Junczys-Dowmunt, Roman Grundkiewicz, Tomasz Dwojak, Hieu Hoang, Kenneth Heafield, Tom Neckermann, Frank Seide, Ulrich Germann, Alham Fikri Aji, Nikolay Bogoychev, André F. T. Martins, Alexandra Birch (2018). Marian: Fast Neural Machine Translation in C++ (http://www.aclweb.org/anthology/P18-4020)
+
+ @InProceedings{mariannmt,
+ title = {Marian: Fast Neural Machine Translation in {C++}},
+ author = {Junczys-Dowmunt, Marcin and Grundkiewicz, Roman and
+ Dwojak, Tomasz and Hoang, Hieu and Heafield, Kenneth and
+ Neckermann, Tom and Seide, Frank and Germann, Ulrich and
+ Fikri Aji, Alham and Bogoychev, Nikolay and
+ Martins, Andr\'{e} F. T. and Birch, Alexandra},
+ booktitle = {Proceedings of ACL 2018, System Demonstrations},
+ pages = {116--121},
+ publisher = {Association for Computational Linguistics},
+ year = {2018},
+ month = {July},
+ address = {Melbourne, Australia},
+ url = {http://www.aclweb.org/anthology/P18-4020}
+ }
+
+<!--
## Compilation
```
@@ -26,19 +59,15 @@ cd build
cmake .. -DCMAKE_BUILD_TYPE=Release
make -j
```
+-->
## Website
More information on https://marian-nmt.github.io
-## Mailing lists
-
-* General google group: https://groups.google.com/forum/#!forum/marian-nmt (for users and developers)
-* Google group for commit messages: https://groups.google.com/forum/#!forum/marian-nmt-commits (for developers)
-
-## Contributions
-
-See [CONTRIBUTING.md](https://github.com/marian-nmt/marian-dev/blob/master/CONTRIBUTING.md)
+- [Quick start](https://marian-nmt.github.io/quickstart)
+- [Installation and usage documentation](https://marian-nmt.github.io/docs)
+- [Usage examples](https://marian-nmt.github.io/examples)
## Acknowledgements
@@ -55,4 +84,3 @@ National Intelligence (ODNI), Intelligence Advanced Research Projects Activity
(IARPA), via contract #FA8650-17-C-9117.
This software contains source code provided by NVIDIA Corporation.
-