1890947 - Document pipelines using JSDoc

Status: RESOLVED FIXED

(Core :: Machine Learning: General, enhancement)

Description

[Tarek Ziadé (:tarek)]

Each pipeline implemented in the inference engine comes with different options to run.

For instance, the image-to-text one can take an image UR or an image as an array buffer. The request object that is used to pass the option from the caller to the engine is a generic envelope.

In order to document how the inference engine is used, and since each pipeline is a function, lets plug each function JSDoc in a reST text in our documentation. see https://firefox-source-docs.mozilla.org/tools/moztreedocs/jsdoc-support.html

The document should also provide a step-by-type guide to add a new pipeline

Comment 1

[Tarek Ziadé (:tarek)]

Attachment: Bug 1890947 - Document pipelines using JSDoc r?gregtatum

Comment 2

[Tarek Ziadé (:tarek)]

The document should also provide a step-by-type guide to add a new pipeline

will be done in a follow-up bug

Comment 3

[Tarek Ziadé (:tarek)]

about the warning : https://bugzilla.mozilla.org/show_bug.cgi?id=1706691

Comment 4

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/7c15eacd7f68
Document pipelines using JSDoc r=gregtatum

Comment 5

[Aron Cseh]

Backed out for causing doc generate failure

• Backout link
• Push with failures
• Failure Log

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/6aaf3e25bc4f
Document pipelines using JSDoc r=gregtatum a=reland CLOSED TREE

Comment 7

[Cosmin Sabou [:CosminS]]

https://hg.mozilla.org/mozilla-central/rev/6aaf3e25bc4f