Rename FF14Translator→FF14JaKoTranslator

sappho192 · Jun 13, 2024 · 25ee5ba · 25ee5ba
1 parent 983b9b9
commit 25ee5ba
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -26,12 +26,12 @@ Text translator library based on LLM models, especially EncoderDecoderModel in H
 
 # Supported models
 
-* FF14Translator([sappho192/ffxiv-ja-ko-translator](https://github.com/sappho192/ffxiv-ja-ko-translator)): Japanese-to-Korean translator based on `bert-base-japanese` and `skt-kogpt2-base-v2`
+* FF14JaKoTranslator([sappho192/ffxiv-ja-ko-translator](https://github.com/sappho192/ffxiv-ja-ko-translator)): Japanese-to-Korean translator based on `bert-base-japanese` and `skt-kogpt2-base-v2`
 * More to be added...
 
 # Quickstart
 
-Following guide supposes that you are to use FF14Translator mentioned above.
+Following guide supposes that you are to use FF14JaKoTranslator mentioned above.
 
 ## Install the packages
 
@@ -54,7 +54,7 @@ Write the code like below and you are good to go 🫡
 Note that you need to fix the path of `encoderDictDir` and `modelDir` correctly.
 
 ```csharp
- // Console application which translates Japanese sentence to Korean based on FF14Translator
+ // Console application which translates Japanese sentence to Korean based on FF14JaKoTranslator
 
 using EDMTranslator.Tokenization;
 using EDMTranslator.Translation;
@@ -90,8 +90,8 @@ TestTokenizer(tokenizer);
 
 // Prepare the translator
 string modelDir = @"D:\MODEL\ffxiv-ja-ko-translator\onnx"; // Contains encoder_model.onnx and decoder_model_merged.onnx
-var translator = new FF14Translator(tokenizer, modelDir);
-void TestTranslator(FF14Translator translator)
+var translator = new FF14JaKoTranslator(tokenizer, modelDir);
+void TestTranslator(FF14JaKoTranslator translator)
 {
     Console.WriteLine("--Translator test--");
     Translate(translator, "打ち合わせが終わった後にご飯を食べましょう。");
@@ -101,7 +101,7 @@ void TestTranslator(FF14Translator translator)
 }
 TestTranslator(translator);
 
-static void Translate(FF14Translator translator, string sentence)
+static void Translate(FF14JaKoTranslator translator, string sentence)
 {
     Console.WriteLine($"SourceText: {sentence}");
     string translated = translator.Translate(sentence);

diff --git a/...MTranslator/Translation/FF14Translator.cs → ...nslator/Translation/FF14JaKoTranslator.cs b/...MTranslator/Translation/FF14Translator.cs → ...nslator/Translation/FF14JaKoTranslator.cs
@@ -6,12 +6,12 @@
 
 namespace EDMTranslator.Translation
 {
-    public class FF14Translator : EncoderDecoderTranslator
+    public class FF14JaKoTranslator : EncoderDecoderTranslator
     {
         private readonly InferenceSession encoderSession;
         private readonly InferenceSession decoderSession;
 
-        public FF14Translator(BertJa2KoGPTTokenizer tokenizer, string modelDirPath) : base(
+        public FF14JaKoTranslator(BertJa2KoGPTTokenizer tokenizer, string modelDirPath) : base(
             modelName: "ffxiv-ja-ko-translator",
             modelHubName: "sappho192/ffxiv-ja-ko-translator",
             tokenizer: tokenizer)

diff --git a/src/ExampleApp/Program.cs b/src/ExampleApp/Program.cs
@@ -32,8 +32,8 @@ void TestTokenizer(ITokenizer tokenizer)
 
 // Prepare the translator
 string modelDir = @"D:\MODEL\ffxiv-ja-ko-translator\onnx";
-var translator = new FF14Translator(tokenizer, modelDir);
-void TestTranslator(FF14Translator translator)
+var translator = new FF14JaKoTranslator(tokenizer, modelDir);
+void TestTranslator(FF14JaKoTranslator translator)
 {
     Console.WriteLine("--Translator test--");
     Translate(translator, "打ち合わせが終わった後にご飯を食べましょう。");
@@ -43,7 +43,7 @@ void TestTranslator(FF14Translator translator)
 }
 TestTranslator(translator);
 
-static void Translate(FF14Translator translator, string sentence)
+static void Translate(FF14JaKoTranslator translator, string sentence)
 {
     Console.WriteLine($"SourceText: {sentence}");
     string translated = translator.Translate(sentence);