tesseract  5.0.0-alpha-619-ge9db
combine_lang_model.cpp
Go to the documentation of this file.
1 // Copyright 2017 Google Inc. All Rights Reserved.
2 // Author: rays@google.com (Ray Smith)
3 // Purpose: Program to generate a traineddata file that can be used to train an
4 // LSTM-based neural network model from a unicharset and an optional
5 // set of wordlists. Eliminates the need to run
6 // set_unicharset_properties, wordlist2dawg, some non-existent binary
7 // to generate the recoder, and finally combine_tessdata.
8 
9 // Licensed under the Apache License, Version 2.0 (the "License");
10 // you may not use this file except in compliance with the License.
11 // You may obtain a copy of the License at
12 // http://www.apache.org/licenses/LICENSE-2.0
13 // Unless required by applicable law or agreed to in writing, software
14 // distributed under the License is distributed on an "AS IS" BASIS,
15 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 // See the License for the specific language governing permissions and
17 // limitations under the License.
18 
19 #include "commandlineflags.h"
20 #include "commontraining.h" // CheckSharedLibraryVersion
21 #include "lang_model_helpers.h"
22 #include "tprintf.h"
24 
25 static STRING_PARAM_FLAG(input_unicharset, "",
26  "Filename with unicharset to complete and use in encoding");
27 static STRING_PARAM_FLAG(script_dir, "",
28  "Directory name for input script unicharsets");
29 static STRING_PARAM_FLAG(words, "",
30  "File listing words to use for the system dictionary");
31 static STRING_PARAM_FLAG(puncs, "", "File listing punctuation patterns");
32 static STRING_PARAM_FLAG(numbers, "", "File listing number patterns");
33 static STRING_PARAM_FLAG(output_dir, "", "Root directory for output files");
34 static STRING_PARAM_FLAG(version_str, "", "Version string to add to traineddata file");
35 static STRING_PARAM_FLAG(lang, "", "Name of language being processed");
36 static BOOL_PARAM_FLAG(lang_is_rtl, false,
37  "True if lang being processed is written right-to-left");
38 static BOOL_PARAM_FLAG(pass_through_recoder, false,
39  "If true, the recoder is a simple pass-through of the "
40  "unicharset. Otherwise, potentially a compression of it");
41 
42 int main(int argc, char** argv) {
43  // Sets properties on the input unicharset file, and writes:
44  // rootdir/lang/lang.charset_size=ddd.txt
45  // rootdir/lang/lang.traineddata
46  // rootdir/lang/lang.unicharset
47  // If the 3 word lists are provided, the dawgs are also added
48  // to the traineddata file.
49  // The output unicharset and charset_size files are just for
50  // human readability.
51  tesseract::CheckSharedLibraryVersion();
52  tesseract::ParseCommandLineFlags(argv[0], &argc, &argv, true);
53 
54  GenericVector<STRING> words, puncs, numbers;
55  // If these reads fail, we get a warning message and an empty list of words.
56  tesseract::ReadFile(FLAGS_words.c_str(), nullptr).split('\n', &words);
57  tesseract::ReadFile(FLAGS_puncs.c_str(), nullptr).split('\n', &puncs);
58  tesseract::ReadFile(FLAGS_numbers.c_str(), nullptr).split('\n', &numbers);
59  // Load the input unicharset
60  UNICHARSET unicharset;
61  if (!unicharset.load_from_file(FLAGS_input_unicharset.c_str(), false)) {
62  tprintf("Failed to load unicharset from %s\n",
63  FLAGS_input_unicharset.c_str());
64  return 1;
65  }
66  tprintf("Loaded unicharset of size %d from file %s\n", unicharset.size(),
67  FLAGS_input_unicharset.c_str());
68 
69  // Set unichar properties
70  tprintf("Setting unichar properties\n");
71  tesseract::SetupBasicProperties(/*report_errors*/ true,
72  /*decompose (NFD)*/ false, &unicharset);
73  tprintf("Setting script properties\n");
74  tesseract::SetScriptProperties(FLAGS_script_dir.c_str(), &unicharset);
75  // Combine everything into a traineddata file.
77  unicharset, FLAGS_script_dir.c_str(), FLAGS_version_str.c_str(),
78  FLAGS_output_dir.c_str(), FLAGS_lang.c_str(), FLAGS_pass_through_recoder,
79  words, puncs, numbers, FLAGS_lang_is_rtl, /*reader*/ nullptr,
80  /*writer*/ nullptr);
81 }
UNICHARSET::load_from_file
bool load_from_file(const char *const filename, bool skip_fragments)
Definition: unicharset.h:378
tesseract::CombineLangModel
int CombineLangModel(const UNICHARSET &unicharset, const std::string &script_dir, const std::string &version_str, const std::string &output_dir, const std::string &lang, bool pass_through_recoder, const GenericVector< STRING > &words, const GenericVector< STRING > &puncs, const GenericVector< STRING > &numbers, bool lang_is_rtl, FileReader reader, FileWriter writer)
Definition: lang_model_helpers.cpp:185
BOOL_PARAM_FLAG
#define BOOL_PARAM_FLAG(name, val, comment)
Definition: commandlineflags.h:33
unicharset_training_utils.h
commontraining.h
STRING_PARAM_FLAG
#define STRING_PARAM_FLAG(name, val, comment)
Definition: commandlineflags.h:37
tesseract::SetupBasicProperties
void SetupBasicProperties(bool report_errors, bool decompose, UNICHARSET *unicharset)
Definition: unicharset_training_utils.cpp:40
tesseract::ParseCommandLineFlags
void ParseCommandLineFlags(const char *usage, int *argc, char ***argv, const bool remove_flags)
Definition: commandlineflags.cpp:166
lang_model_helpers.h
main
int main(int argc, char **argv)
Definition: combine_lang_model.cpp:42
UNICHARSET
Definition: unicharset.h:145
tprintf.h
GenericVector< STRING >
tesseract::SetScriptProperties
void SetScriptProperties(const std::string &script_dir, UNICHARSET *unicharset)
Definition: unicharset_training_utils.cpp:143
tesseract::ReadFile
STRING ReadFile(const std::string &filename, FileReader reader)
Definition: lang_model_helpers.cpp:57
tprintf
DLLSYM void tprintf(const char *format,...)
Definition: tprintf.cpp:34
commandlineflags.h
UNICHARSET::size
int size() const
Definition: unicharset.h:341