Skip to content

Commit

Permalink
Slight updates to language code documentaiton - Document language cod…
Browse files Browse the repository at this point in the history 
…es in Wiki #195 (#200)
  • Loading branch information
@johnml1135
johnml1135 authored Oct 30, 2023
1 parent fdc7ce0 commit f710837
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 33 deletions.
34 changes: 12 additions & 22 deletions src/Serval.Client/Client.g.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -803,20 +803,15 @@ public partial interface ITranslationEnginesClient
/// <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/>The Statistical Machine Translation Transfer Learning engine is primarily used for translation suggestions. 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 Meta's NLLB-200. Valid IETF language tags provided to Serval will be converted to [NLLB-200 codes](https://github.com/facebookresearch/flores/tree/main/flores200#languages-in-flores-200).
/// <br/>If you use a language among NLLB's supported languages,
/// <br/>Serval will utilize everything the NLLB-200 model already knows about that language when translating.
/// <br/>If the language you are working with is not among NLLB's supported languages, the language code will have no effect.
/// <br/>The Neural Machine Translation engine is primarily used for pretranslations. It is fine-tuned from Meta's NLLB-200. Valid IETF language tags provided to Serval will be converted to [NLLB-200 codes](https://github.com/facebookresearch/flores/tree/main/flores200#languages-in-flores-200). See more about language tag resolution [here](https://github.com/sillsdev/serval/wiki/Language-Tag-Resolution-for-NLLB%E2%80%90200).
/// <br/>
/// <br/>If you use a language among NLLB's supported languages, Serval will utilize everything the NLLB-200 model already knows about that language when translating. If the language you are working with is not among NLLB's supported languages, the language code will have no effect.
/// <br/>
/// <br/>Typical endpoints: pretranslate
/// <br/>### Echo
/// <br/>The Echo engine has full coverage of all Nmt and SmtTransfer endpoints. Endpoints like create and build
/// <br/>return empty responses. Endpoints like translate and get-word-graph echo the sent content back to the user
/// <br/>in a format that mocks Nmt or Smt. For example, translating a segment "test" with the Echo engine would
/// <br/>yield a translation response with translation "test". This engine is useful for debugging and testing purposes.
/// <br/>The Echo engine has full coverage of all Nmt and SmtTransfer endpoints. Endpoints like create and build return empty responses. Endpoints like translate and get-word-graph echo the sent content back to the user in a format that mocks Nmt or Smt. For example, translating a segment "test" with the Echo engine would yield a translation response with translation "test". This engine is useful for debugging and testing purposes.
/// <br/>## Sample request:
/// <br/>
/// <br/> {
Expand Down Expand Up @@ -1208,20 +1203,15 @@ public string BaseUrl
/// <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/>The Statistical Machine Translation Transfer Learning engine is primarily used for translation suggestions. 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 Meta's NLLB-200. Valid IETF language tags provided to Serval will be converted to [NLLB-200 codes](https://github.com/facebookresearch/flores/tree/main/flores200#languages-in-flores-200).
/// <br/>If you use a language among NLLB's supported languages,
/// <br/>Serval will utilize everything the NLLB-200 model already knows about that language when translating.
/// <br/>If the language you are working with is not among NLLB's supported languages, the language code will have no effect.
/// <br/>The Neural Machine Translation engine is primarily used for pretranslations. It is fine-tuned from Meta's NLLB-200. Valid IETF language tags provided to Serval will be converted to [NLLB-200 codes](https://github.com/facebookresearch/flores/tree/main/flores200#languages-in-flores-200). See more about language tag resolution [here](https://github.com/sillsdev/serval/wiki/Language-Tag-Resolution-for-NLLB%E2%80%90200).
/// <br/>
/// <br/>If you use a language among NLLB's supported languages, Serval will utilize everything the NLLB-200 model already knows about that language when translating. If the language you are working with is not among NLLB's supported languages, the language code will have no effect.
/// <br/>
/// <br/>Typical endpoints: pretranslate
/// <br/>### Echo
/// <br/>The Echo engine has full coverage of all Nmt and SmtTransfer endpoints. Endpoints like create and build
/// <br/>return empty responses. Endpoints like translate and get-word-graph echo the sent content back to the user
/// <br/>in a format that mocks Nmt or Smt. For example, translating a segment "test" with the Echo engine would
/// <br/>yield a translation response with translation "test". This engine is useful for debugging and testing purposes.
/// <br/>The Echo engine has full coverage of all Nmt and SmtTransfer endpoints. Endpoints like create and build return empty responses. Endpoints like translate and get-word-graph echo the sent content back to the user in a format that mocks Nmt or Smt. For example, translating a segment "test" with the Echo engine would yield a translation response with translation "test". This engine is useful for debugging and testing purposes.
/// <br/>## Sample request:
/// <br/>
/// <br/> {
Expand Down
17 changes: 6 additions & 11 deletions src/Serval.Translation/Controllers/TranslationEnginesController.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,20 +91,15 @@ CancellationToken cancellationToken
/// * **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
/// 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 Meta's NLLB-200. Valid IETF language tags provided to Serval will be converted to [NLLB-200 codes](https://github.com/facebookresearch/flores/tree/main/flores200#languages-in-flores-200).
/// If you use a language among NLLB's supported languages,
/// Serval will utilize everything the NLLB-200 model already knows about that language when translating.
/// If the language you are working with is not among NLLB's supported languages, the language code will have no effect.
/// The Neural Machine Translation engine is primarily used for pretranslations. It is fine-tuned from Meta's NLLB-200. Valid IETF language tags provided to Serval will be converted to [NLLB-200 codes](https://github.com/facebookresearch/flores/tree/main/flores200#languages-in-flores-200). See more about language tag resolution [here](https://github.com/sillsdev/serval/wiki/Language-Tag-Resolution-for-NLLB%E2%80%90200).
///
/// If you use a language among NLLB's supported languages, Serval will utilize everything the NLLB-200 model already knows about that language when translating. If the language you are working with is not among NLLB's supported languages, the language code will have no effect.
///
/// Typical endpoints: pretranslate
/// ### Echo
/// The Echo engine has full coverage of all Nmt and SmtTransfer endpoints. Endpoints like create and build
/// return empty responses. Endpoints like translate and get-word-graph echo the sent content back to the user
/// in a format that mocks Nmt or Smt. For example, translating a segment "test" with the Echo engine would
/// yield a translation response with translation "test". This engine is useful for debugging and testing purposes.
/// The Echo engine has full coverage of all Nmt and SmtTransfer endpoints. Endpoints like create and build return empty responses. Endpoints like translate and get-word-graph echo the sent content back to the user in a format that mocks Nmt or Smt. For example, translating a segment "test" with the Echo engine would yield a translation response with translation "test". This engine is useful for debugging and testing purposes.
/// ## Sample request:
///
/// {
Expand Down

0 comments on commit f710837

Please sign in to comment.