Skip to content

Commit

Permalink
Ietf tag doc update #134 (#136)
Browse files Browse the repository at this point in the history
* Update documentation; fixes #134

* Updates as per PR --ECL

* Stronger recommendations

---------

Co-authored-by: John Lambert <john_lambert@sil.org>
  • Loading branch information
Enkidu93 and johnml1135 authored Sep 21, 2023
1 parent 1f3a865 commit 321019c
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 12 deletions.
14 changes: 6 additions & 8 deletions src/Serval.Client/Client.g.cs
Original file line number Diff line number Diff line change
Expand Up @@ -793,16 +793,15 @@ public partial interface ITranslationEnginesClient
/// <br/>* **name**: A name to help identify and distinguish the file.
/// <br/> * Recommendation: Create a multi-part name to distinguish between projects, uses, etc.
/// <br/> * The name does not have to be unique, as the engine is uniquely identified by the auto-generated id
/// <br/>* **sourceLanguage**: The source language code
/// <br/> * Note that for Nmt, if the source or target language code matches an [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag), it will be converted to an [NLLB-200 code](https://github.com/facebookresearch/flores/tree/main/flores200#languages-in-flores-200) and use the language as-is.
/// <br/>* **targetLanguage**: The target language code
/// <br/>* **sourceLanguage**: The source language code (a valid [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) is recommended)
/// <br/>* **targetLanguage**: The target language code (a valid IETF language tag is recommended)
/// <br/>* **type**: **SmtTransfer** or **Nmt** or **Echo**
/// <br/>### SmtTransfer
/// <br/>The Statistical Machine Translation Transfer Learning engine is primarily used for translation suggestions.
/// <br/>Typical endpoints: translate, get-word-graph, train-segment
/// <br/>### Nmt
/// <br/>The Neural Machine Translation engine is primarily used for pretranslations. It is
/// <br/>fine tuned from the NLLB-200 from Meta and inherits the 200 language codes.
/// <br/>fine tuned from the NLLB-200 from Meta and inherits the 200 language codes. Valid IETF language tags will be converted to an [NLLB-200 code](https://github.com/facebookresearch/flores/tree/main/flores200#languages-in-flores-200), and NLLB will be used as-is.
/// <br/>Typical endpoints: pretranslate
/// <br/>### Echo
/// <br/>The Echo engine has full coverage of all Nmt and SmtTransfer endpoints. Endpoints like create and build
Expand Down Expand Up @@ -1181,16 +1180,15 @@ public string BaseUrl
/// <br/>* **name**: A name to help identify and distinguish the file.
/// <br/> * Recommendation: Create a multi-part name to distinguish between projects, uses, etc.
/// <br/> * The name does not have to be unique, as the engine is uniquely identified by the auto-generated id
/// <br/>* **sourceLanguage**: The source language code
/// <br/> * Note that for Nmt, if the source or target language code matches an [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag), it will be converted to an [NLLB-200 code](https://github.com/facebookresearch/flores/tree/main/flores200#languages-in-flores-200) and use the language as-is.
/// <br/>* **targetLanguage**: The target language code
/// <br/>* **sourceLanguage**: The source language code (a valid [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) is recommended)
/// <br/>* **targetLanguage**: The target language code (a valid IETF language tag is recommended)
/// <br/>* **type**: **SmtTransfer** or **Nmt** or **Echo**
/// <br/>### SmtTransfer
/// <br/>The Statistical Machine Translation Transfer Learning engine is primarily used for translation suggestions.
/// <br/>Typical endpoints: translate, get-word-graph, train-segment
/// <br/>### Nmt
/// <br/>The Neural Machine Translation engine is primarily used for pretranslations. It is
/// <br/>fine tuned from the NLLB-200 from Meta and inherits the 200 language codes.
/// <br/>fine tuned from the NLLB-200 from Meta and inherits the 200 language codes. Valid IETF language tags will be converted to an [NLLB-200 code](https://github.com/facebookresearch/flores/tree/main/flores200#languages-in-flores-200), and NLLB will be used as-is.
/// <br/>Typical endpoints: pretranslate
/// <br/>### Echo
/// <br/>The Echo engine has full coverage of all Nmt and SmtTransfer endpoints. Endpoints like create and build
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -87,16 +87,15 @@ CancellationToken cancellationToken
/// * **name**: A name to help identify and distinguish the file.
/// * Recommendation: Create a multi-part name to distinguish between projects, uses, etc.
/// * The name does not have to be unique, as the engine is uniquely identified by the auto-generated id
/// * **sourceLanguage**: The source language code
/// * Note that for Nmt, if the source or target language code matches an [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag), it will be converted to an [NLLB-200 code](https://github.com/facebookresearch/flores/tree/main/flores200#languages-in-flores-200) and use the language as-is.
/// * **targetLanguage**: The target language code
/// * **sourceLanguage**: The source language code (a valid [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) is recommended)
/// * **targetLanguage**: The target language code (a valid IETF language tag is recommended)
/// * **type**: **SmtTransfer** or **Nmt** or **Echo**
/// ### SmtTransfer
/// The Statistical Machine Translation Transfer Learning engine is primarily used for translation suggestions.
/// Typical endpoints: translate, get-word-graph, train-segment
/// ### Nmt
/// The Neural Machine Translation engine is primarily used for pretranslations. It is
/// fine tuned from the NLLB-200 from Meta and inherits the 200 language codes.
/// fine tuned from the NLLB-200 from Meta and inherits the 200 language codes. Valid IETF language tags will be converted to an [NLLB-200 code](https://github.com/facebookresearch/flores/tree/main/flores200#languages-in-flores-200), and NLLB will be used as-is.
/// Typical endpoints: pretranslate
/// ### Echo
/// The Echo engine has full coverage of all Nmt and SmtTransfer endpoints. Endpoints like create and build
Expand Down

0 comments on commit 321019c

Please sign in to comment.