Update README to reflect main repo

This commit is contained in:
Marcin Junczys-Dowmunt 2018-09-16 11:56:46 +02:00 committed by GitHub
parent 5a42fdd3e6
commit 46b0232339
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -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)
<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.
**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.
<!--It has mainly been developed at the
Adam Mickiewicz University in Poznań (AMU) and at the University of Edinburgh.-->
</p>
https://github.com/marian-nmt/marian is updated with stable versions of this
repository.
<!--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-->
Named in honour of Marian Rejewski, a Polish mathematician and cryptologist.
<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.