From 487d33942e33921f9f14815b08830db5e0ada0a5 Mon Sep 17 00:00:00 2001 From: John Lambert Date: Tue, 26 Mar 2024 20:13:07 -0400 Subject: [PATCH] API Doc updates --- src/Serval.Client/Client.g.cs | 18 ++++++++++-------- src/Serval.Client/Serval.Client.csproj | 2 +- .../TranslationEnginesController.cs | 9 +++++---- 3 files changed, 16 insertions(+), 13 deletions(-) diff --git a/src/Serval.Client/Client.g.cs b/src/Serval.Client/Client.g.cs index a8c0b351..d77a0b33 100644 --- a/src/Serval.Client/Client.g.cs +++ b/src/Serval.Client/Client.g.cs @@ -1512,10 +1512,11 @@ public partial interface ITranslationEnginesClient ///
* **TextId**: The client-defined name to associate source and target files. ///
* If the TextIds in the SourceFiles and TargetFiles match, they will be used to train the engine. ///
* If selected for pretranslation when building, all SourceFiles that have no TargetFile, or lines of text in a SourceFile that have missing or blank lines in the TargetFile will be pretranslated. - ///
* A TextId should only be used at most once in SourceFiles and in TargetFiles. - ///
* If the file is a Paratext project, this field should be left blank. Any TextId provided will be ignored. - ///
* **TargetFiles**: The source files associated with the corpus - ///
* Same as SourceFiles. Parallel texts must have a matching TextId. + ///
* If a TextId is used more than once in SourceFiles, the sources will be randomly and evenly mixed for training. + ///
* For pretranslating, multiple sources with the same TextId will be combined, but the first source will always take precedence (no random mixing). + ///
* For Paratext projects, TextId will be ignored - multiple Paratext source projects will always be mixed (as if they have the same TextId). + ///
* **TargetFiles**: The target files associated with the corpus + ///
* Same as SourceFiles, except only a single instance of a TextID or a single paratext project is supported. There is no mixing or combining of multiple targets. /// /// The translation engine id /// The corpus configuration (see remarks) @@ -2742,10 +2743,11 @@ public string BaseUrl ///
* **TextId**: The client-defined name to associate source and target files. ///
* If the TextIds in the SourceFiles and TargetFiles match, they will be used to train the engine. ///
* If selected for pretranslation when building, all SourceFiles that have no TargetFile, or lines of text in a SourceFile that have missing or blank lines in the TargetFile will be pretranslated. - ///
* A TextId should only be used at most once in SourceFiles and in TargetFiles. - ///
* If the file is a Paratext project, this field should be left blank. Any TextId provided will be ignored. - ///
* **TargetFiles**: The source files associated with the corpus - ///
* Same as SourceFiles. Parallel texts must have a matching TextId. + ///
* If a TextId is used more than once in SourceFiles, the sources will be randomly and evenly mixed for training. + ///
* For pretranslating, multiple sources with the same TextId will be combined, but the first source will always take precedence (no random mixing). + ///
* For Paratext projects, TextId will be ignored - multiple Paratext source projects will always be mixed (as if they have the same TextId). + ///
* **TargetFiles**: The target files associated with the corpus + ///
* Same as SourceFiles, except only a single instance of a TextID or a single paratext project is supported. There is no mixing or combining of multiple targets. /// /// The translation engine id /// The corpus configuration (see remarks) diff --git a/src/Serval.Client/Serval.Client.csproj b/src/Serval.Client/Serval.Client.csproj index 2fe3d9ca..5142c0d4 100644 --- a/src/Serval.Client/Serval.Client.csproj +++ b/src/Serval.Client/Serval.Client.csproj @@ -2,7 +2,7 @@ netstandard2.1 - 1.3.0 + 1.3.1 Client classes for Serval. Serval.Client 8618 diff --git a/src/Serval.Translation/Controllers/TranslationEnginesController.cs b/src/Serval.Translation/Controllers/TranslationEnginesController.cs index 09957717..02694ccc 100644 --- a/src/Serval.Translation/Controllers/TranslationEnginesController.cs +++ b/src/Serval.Translation/Controllers/TranslationEnginesController.cs @@ -321,10 +321,11 @@ await _engineService.TrainSegmentPairAsync( /// * **TextId**: The client-defined name to associate source and target files. /// * If the TextIds in the SourceFiles and TargetFiles match, they will be used to train the engine. /// * If selected for pretranslation when building, all SourceFiles that have no TargetFile, or lines of text in a SourceFile that have missing or blank lines in the TargetFile will be pretranslated. - /// * A TextId should only be used at most once in SourceFiles and in TargetFiles. - /// * If the file is a Paratext project, this field should be left blank. Any TextId provided will be ignored. - /// * **TargetFiles**: The source files associated with the corpus - /// * Same as SourceFiles. Parallel texts must have a matching TextId. + /// * If a TextId is used more than once in SourceFiles, the sources will be randomly and evenly mixed for training. + /// * For pretranslating, multiple sources with the same TextId will be combined, but the first source will always take precedence (no random mixing). + /// * For Paratext projects, TextId will be ignored - multiple Paratext source projects will always be mixed (as if they have the same TextId). + /// * **TargetFiles**: The target files associated with the corpus + /// * Same as SourceFiles, except only a single instance of a TextID or a single paratext project is supported. There is no mixing or combining of multiple targets. /// /// The translation engine id /// The corpus configuration (see remarks)