mirror of
https://github.com/browsermt/bergamot-translator.git
synced 2024-10-26 05:43:59 +03:00
a3250b401f
Adds doxygen configurations, additional sphinx which consumes the doxygen files to generate developer API, compatible with marian-nmt/marian-dev.
39 lines
1.2 KiB
ReStructuredText
39 lines
1.2 KiB
ReStructuredText
Welcome to Bergamot Translator's documentation!
|
|
===============================================
|
|
|
|
|buildcpu| |tests| |release| |license|
|
|
|
|
Bergamot translator provides a unified API for (Marian NMT framework based)
|
|
neural machine translation functionality in accordance with the Bergamot
|
|
project that focuses on improving client-side machine translation in a web
|
|
browser.
|
|
|
|
This is developer documentation.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Contents:
|
|
|
|
marian-integration
|
|
api/library_index
|
|
|
|
|
|
|
|
Indices and tables
|
|
------------------
|
|
|
|
* :ref:`genindex`
|
|
|
|
|
|
.. |buildcpu| image:: https://img.shields.io/jenkins/s/http/vali.inf.ed.ac.uk/jenkins/view/browsermt/job/bergamot-translator.svg?label=CPU%20Build
|
|
:target: http://vali.inf.ed.ac.uk/jenkins/job/bergamot-translator
|
|
:alt: CPU build status
|
|
|
|
.. |tests| image:: https://img.shields.io/jenkins/s/http/vali.inf.ed.ac.uk/jenkins/view/marian/job/bergamot-translator-regression-tests.svg?label=Tests
|
|
:target: http://vali.inf.ed.ac.uk/jenkins/job/bergamot-translator-regression-tests/
|
|
:alt: Tests status
|
|
|
|
.. |license| image:: https://img.shields.io/badge/License-MPL%202.0-brightgreen.svg
|
|
:target: https://opensource.org/licenses/MPL-2.0
|
|
:alt: License: MPL
|