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
path: root/doc
AgeCommit message (Collapse)Author
2022-02-08Document Structure (#910)Graeme Nail
* Add architectural outline * Update index
2022-01-26Layer documentation (#892)Qianqian Zhu
* More examples for MLP layers and docs about RNN layers * Docs about embedding layer and more doxygen code docs * Add layer and factors docs into index.rst * Update layer documentation * Fix typos Co-authored-by: Roman Grundkiewicz <rgrundkiewicz@gmail.com> Co-authored-by: Graeme Nail <graemenail.work@gmail.com>
2021-12-07Documentation about how to write code documentation (#891)Qianqian Zhu
* add initial guidelines of code documentation * fix math formula not displayed in Sphinx * remove @name tags which cannot be extracted by exhale and cause function signature errors * fix markdown ref warning and update markdown parser in sphinx * more about doxygen: add Doxygen commands and math formulas * move code doc guide to a new .rst file * add formula image * Set myst-parser version appropriate for the requested sphinx version * Update documentation on how to write Doxygen comments * Add new section to the documentation index * Sphinx 2.4.4 requires myst-parser 0.14 * complete code doc guide and small fixes on reStructuredText formats * More about reStructuredText * Update badges on the documentation frontpage Co-authored-by: Roman Grundkiewicz <rgrundkiewicz@gmail.com>
2021-12-06Constrain version of mistune to before v2 in GitHub CI Documentation builds ↵Graeme Nail
(#894)
2021-09-08Factor concatenation improvements and documentation (#748)Kenneth Heafield
* concatenation combining option added when embeding using factors * crossMask not used by default * added an option to better clarify when choosing factor predictor options * fixed bug when choosing re-embedding option and not setting embedding size * avoid uncessary string copy * Check in factors documentation * Fix duplication in merge * Self-referential repository * change --factors-predictor to --lemma-dependency. Default behaviour changed. * factor related options are now stored with the model * Update doc/factors.md * add backward compability for the target factors * Move backward compatibility checks for factors to happen after the model.npz config is loaded * Add explicit error msg if using concat on target * Update func comments. Fix spaces * Add Marian version requirement * delete experimental code Co-authored-by: Pedro Coelho <pedrodiascoelho97@gmail.com> Co-authored-by: Pedro Coelho <pedro.coelho@unbabel.com> Co-authored-by: Roman Grundkiewicz <rgrundkiewicz@gmail.com>
2021-02-28Remove doc/installRoman Grundkiewicz
2021-02-28Add graph operations documentation (#801)Graeme
* Doxygen structure for expression graph operators * Document arithmetic expression operations * Document comparison expression operations * Document exp/log and trig operations * Add missing implementation for cos/tan * Document expression manipulation operations * Document misc math operations * Overview of operators * Document activation functions * Document element-wise min/max * Document debugging/checkpoint operators * Document topk/argmin/argmax operations * Document index-based operations * Document reduction operations * Document lambda expression operators * Document product operations * Document softmax, cross-entropy, unlikelihood operations * Document dropout operations * Document scalar product and weighted average operations * Document layer normalization, highway and pooling operations * Document shift expression operator * Extra details on rules for adding specializations to .inc files * Add SinNodeOp example for specialization documentation * Additional details in tensor operator documentation * Remove brief command from doxygen comments * Prefer @ style doxygen functions to \ * Document n-ary function macros * Enable .cu and .inc files in documentation * Add a comment about ONNX mapping * Remove empty lines in doxygen * Update CHANGELOG Co-authored-by: Roman Grundkiewicz <rgrundkiewicz@gmail.com>
2021-02-28Add graph documentations (#788)Qianqian Zhu
* add API docs for expression_graph.h * change API docs to doxygen-readable format * add API docs for node_initializers * update doxygen configure file * add hyperlinks and remove layers section from graph documentation * fixing typos and links on graph doc
2021-02-23Add documentation platform based on Sphinx+Doxygen+Breathe+Exhale (#803)Roman Grundkiewicz
* Setup Sphinx+Doxygen+Breathe+Exhale * Remove links to modindex and search pages * Enable Doxygen autobrief
2016-10-06Added more referencesLane Schwartz
2016-10-05Add references fileLane Schwartz