marian/doc/index.rst
Marcin Junczys-Dowmunt 1e92cff93d Merged PR 25919: Sync with public master - no review required
Sync with public master, checking compilation, regression tests etc.
2022-10-04 00:42:52 +00:00

52 lines
1.5 KiB
ReStructuredText

Welcome to Marian's documentation!
==================================
|ubuntu| |windows| |macos| |release| |license|
Marian is an efficient and self-contained Neural Machine Translation framework with an integrated
automatic differentiation engine based on dynamic computation graphs, written entirely in C++.
This is developer documentation. User documentation is available at https://marian-nmt.github.io/docs/
.. toctree::
:maxdepth: 2
:caption: Contents:
structure
graph
operators
layer
factors
api/library_index
CONTRIBUTING
doc_guide
Indices and tables
------------------
* :ref:`genindex`
.. |ubuntu| image:: https://github.com/marian-nmt/marian-dev/actions/workflows/ubuntu.yml/badge.svg
:target: https://github.com/marian-nmt/marian-dev/actions/workflows/ubuntu.yml
:alt: Ubuntu build status
.. |windows| image:: https://github.com/marian-nmt/marian-dev/actions/workflows/windows.yml/badge.svg
:target: https://github.com/marian-nmt/marian-dev/actions/workflows/windows.yml
:alt: Windows build status
.. |macos| image:: https://github.com/marian-nmt/marian-dev/actions/workflows/macos.yml/badge.svg
:target: https://github.com/marian-nmt/marian-dev/actions/workflows/macos.yml
:alt: MacOS build status
.. |release| image:: https://img.shields.io/github/release/marian-nmt/marian.svg?label=Release
:target: https://github.com/marian-nmt/marian/releases
:alt: Latest release
.. |license| image:: https://img.shields.io/badge/License-MIT-blue.svg
:target: ../LICENSE.md
:alt: License: MIT