mirror of
https://github.com/browsermt/bergamot-translator.git
synced 2024-09-11 13:46:12 +03:00
c0f311a8c0
Imports python bindings and associated sources incubated in https://github.com/jerinphilip/lemonade to bergamot-translator. Adds a pybind11 dependency for python bindings. Following the import, the python build is integrated into the existing CMake based build system here. There is a command-line application provided through python which provides the ability to fetch and prepare models from model-repositories (like browsermt/students or OPUS). Wheels built for a few common operating systems are provided via GitHub releases through automated actions configured to run at tagged semantic versions and pushes to main. The documentation for python is also integrated into our existing documentation setup. Previous documentation GitHub action is now configured to run behind python builds in Ubuntu 18.04 Python3.7, in order to pick up the packaged as a wheel bergamot module and the sphinx documentation using the python module. Formatting checks of black, isort with profile black and a pytype type checker is configured for the python component residing in this repository.
41 lines
1.2 KiB
ReStructuredText
41 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
|
|
wasm-example
|
|
api/library_index
|
|
python
|
|
|
|
|
|
|
|
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
|