From f89c989b444841afd7458df97152ac1401f23750 Mon Sep 17 00:00:00 2001 From: Jerin Philip Date: Wed, 10 Mar 2021 14:55:37 +0000 Subject: [PATCH 01/19] apt-update for ubuntu github actions --- .github/workflows/ubuntu.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ubuntu.yml b/.github/workflows/ubuntu.yml index 940ecdd..6ddd49a 100644 --- a/.github/workflows/ubuntu.yml +++ b/.github/workflows/ubuntu.yml @@ -62,7 +62,7 @@ jobs: # No need to install libprotobuf{17,10,9v5} on Ubuntu {20,18,16}.04 because # it is installed together with libprotobuf-dev - name: Install dependencies - run: sudo apt-get install -y libgoogle-perftools-dev libprotobuf-dev protobuf-compiler libboost-all-dev + run: sudo apt-get update && sudo apt-get install -y libgoogle-perftools-dev libprotobuf-dev protobuf-compiler libboost-all-dev # https://software.intel.com/content/www/us/en/develop/articles/installing-intel-free-libs-and-python-apt-repo.html - name: Install MKL From d75dd85def5f86edd7a6a4f5e35840f1654738c1 Mon Sep 17 00:00:00 2001 From: Nikolay Bogoychev Date: Mon, 22 Mar 2021 14:22:56 +0000 Subject: [PATCH 02/19] Load mode as a byte array (#55) * Switch to wasm branch for this example * Load marian model from a byte array * Sanitise executable names * Change marian branch * Update marian branch that loads binary models * Example of loading model as a byte array * Add the byte array loading files * Die on misaligned memory * Remove the unused argument * Allow loading without a ptr parameter so that we don't break emc workflow --- 3rd_party/marian-dev | 2 +- app/CMakeLists.txt | 10 ++- app/bergamot-translator-app-bytearray.cpp | 72 +++++++++++++++++++ app/{main.cpp => bergamot-translator-app.cpp} | 0 app/service-cli-bytearray.cpp | 40 +++++++++++ app/{main-mts.cpp => service-cli.cpp} | 0 src/AbstractTranslationModel.h | 6 +- src/translator/AbstractTranslationModel.cpp | 8 ++- src/translator/CMakeLists.txt | 1 + src/translator/TranslationModel.cpp | 4 +- src/translator/TranslationModel.h | 6 +- src/translator/batch_translator.cpp | 16 ++++- src/translator/batch_translator.h | 12 +++- src/translator/byteArrayExample.cpp | 45 ++++++++++++ src/translator/byteArrayExample.h | 8 +++ src/translator/service.cpp | 6 +- src/translator/service.h | 7 +- src/translator/service_base.cpp | 4 +- src/translator/service_base.h | 9 ++- 19 files changed, 235 insertions(+), 21 deletions(-) create mode 100644 app/bergamot-translator-app-bytearray.cpp rename app/{main.cpp => bergamot-translator-app.cpp} (100%) create mode 100644 app/service-cli-bytearray.cpp rename app/{main-mts.cpp => service-cli.cpp} (100%) create mode 100644 src/translator/byteArrayExample.cpp create mode 100644 src/translator/byteArrayExample.h diff --git a/3rd_party/marian-dev b/3rd_party/marian-dev index 8ddb73f..370fdb5 160000 --- a/3rd_party/marian-dev +++ b/3rd_party/marian-dev @@ -1 +1 @@ -Subproject commit 8ddb73fad1001ae4c1697d2514ac1e5bd43e2ed3 +Subproject commit 370fdb5a212cfcd2d1c5fca9fffc041d2787a432 diff --git a/app/CMakeLists.txt b/app/CMakeLists.txt index 41c5cd0..3f2b9de 100644 --- a/app/CMakeLists.txt +++ b/app/CMakeLists.txt @@ -1,10 +1,16 @@ -add_executable(bergamot-translator-app main.cpp) +add_executable(bergamot-translator-app bergamot-translator-app.cpp) target_link_libraries(bergamot-translator-app PRIVATE bergamot-translator) +add_executable(bergamot-translator-app-bytearray bergamot-translator-app-bytearray.cpp) +target_link_libraries(bergamot-translator-app-bytearray PRIVATE bergamot-translator) + if (NOT USE_WASM_COMPATIBLE_SOURCES) - add_executable(service-cli main-mts.cpp) + add_executable(service-cli service-cli.cpp) target_link_libraries(service-cli PRIVATE bergamot-translator) + add_executable(service-cli-bytearray service-cli-bytearray.cpp) + target_link_libraries(service-cli-bytearray PRIVATE bergamot-translator) + add_executable(marian-decoder-new marian-decoder-new.cpp) target_link_libraries(marian-decoder-new PRIVATE bergamot-translator) endif() diff --git a/app/bergamot-translator-app-bytearray.cpp b/app/bergamot-translator-app-bytearray.cpp new file mode 100644 index 0000000..961a24e --- /dev/null +++ b/app/bergamot-translator-app-bytearray.cpp @@ -0,0 +1,72 @@ +/* + * main.cpp + * + * An example application to demonstrate the use of Bergamot translator. + * + */ + +#include + +#include "AbstractTranslationModel.h" +#include "TranslationRequest.h" +#include "TranslationResult.h" +#include "translator/parser.h" +#include "translator/byteArrayExample.h" + +int main(int argc, char **argv) { + + // Create a configParser and load command line parameters into a YAML config + // string. + auto configParser = marian::bergamot::createConfigParser(); + auto options = configParser.parseOptions(argc, argv, true); + std::string config = options->asYamlString(); + + // Route the config string to construct marian model through + // AbstractTranslationModel + void * model_bytes = bergamot::getBinaryModelFromConfig(options); + std::shared_ptr model = + AbstractTranslationModel::createInstance(config, model_bytes); + + TranslationRequest translationRequest; + std::vector texts; + texts.emplace_back( + "The Bergamot project will add and improve client-side machine " + "translation in a web browser. Unlike current cloud-based " + "options, running directly on users’ machines empowers citizens to " + "preserve their privacy and increases the uptake of language " + "technologies in Europe in various sectors that require " + "confidentiality."); + texts.emplace_back( + "Free software integrated with an open-source web " + "browser, such as Mozilla Firefox, will enable bottom-up adoption " + "by non-experts, resulting in cost savings for private and public " + "sector users who would otherwise procure translation or operate " + "monolingually. Bergamot is a consortium coordinated by the " + "University of Edinburgh with partners Charles University in " + "Prague, the University of Sheffield, University of Tartu, and " + "Mozilla."); + + auto results = model->translate(std::move(texts), translationRequest); + + // Resolve the future and get the actual result + //std::vector results = futureResults.get(); + + for (auto &result : results) { + std::cout << "[original]: " << result.getOriginalText() << std::endl; + std::cout << "[translated]: " << result.getTranslatedText() << std::endl; + auto mappings = result.getSentenceMappings(); + for (auto &p : mappings) { + std::string_view src = p.first; + std::string_view tgt = p.second; + + std::cout << " [src Sentence]: " << src << std::endl; + std::cout << " [tgt Sentence]: " << tgt << std::endl; + } + std::cout << std::endl; + } + + // Clear the memory used for the byte array + free(model_bytes); // Ideally, this should be done after the translation model has been gracefully shut down. + + return 0; +} diff --git a/app/main.cpp b/app/bergamot-translator-app.cpp similarity index 100% rename from app/main.cpp rename to app/bergamot-translator-app.cpp diff --git a/app/service-cli-bytearray.cpp b/app/service-cli-bytearray.cpp new file mode 100644 index 0000000..42a2af3 --- /dev/null +++ b/app/service-cli-bytearray.cpp @@ -0,0 +1,40 @@ +#include +#include +#include +#include + +#include "common/definitions.h" +#include "common/utils.h" +#include "marian.h" +#include "translator/parser.h" +#include "translator/response.h" +#include "translator/service.h" +#include "translator/byteArrayExample.h" + +int main(int argc, char *argv[]) { + auto cp = marian::bergamot::createConfigParser(); + auto options = cp.parseOptions(argc, argv, true); + + void * model_bytes = bergamot::getBinaryModelFromConfig(options); + marian::bergamot::Service service(options, model_bytes); + + // Read a large input text blob from stdin + std::ostringstream std_input; + std_input << std::cin.rdbuf(); + std::string input = std_input.str(); + using marian::bergamot::Response; + + // Wait on future until Response is complete + std::future responseFuture = service.translate(std::move(input)); + responseFuture.wait(); + Response response = responseFuture.get(); + std::cout << response.translation() << std::endl; + + // Stop Service. + service.stop(); + + // Clear the memory used for the byte array + free(model_bytes); // Ideally, this should be done after the translation model has been gracefully shut down. + + return 0; +} diff --git a/app/main-mts.cpp b/app/service-cli.cpp similarity index 100% rename from app/main-mts.cpp rename to app/service-cli.cpp diff --git a/src/AbstractTranslationModel.h b/src/AbstractTranslationModel.h index 7562b0a..82dcbfa 100644 --- a/src/AbstractTranslationModel.h +++ b/src/AbstractTranslationModel.h @@ -28,8 +28,12 @@ public: * AbstractTranslationModel. The instance is created using translation model * configuration provided as yaml-formatted string. */ + /** + * @param config Marian yml config file in the form of a string + * @param model_memory byte array (aligned to 64!!!) that contains the bytes of a model.bin. Optional, defaults to nullptr when not used + */ static std::shared_ptr - createInstance(const std::string &config); + createInstance(const std::string &config, const void * model_memory=nullptr); AbstractTranslationModel() = default; diff --git a/src/translator/AbstractTranslationModel.cpp b/src/translator/AbstractTranslationModel.cpp index 1b2f2b1..b731c60 100644 --- a/src/translator/AbstractTranslationModel.cpp +++ b/src/translator/AbstractTranslationModel.cpp @@ -8,7 +8,11 @@ #include "AbstractTranslationModel.h" #include "TranslationModel.h" +/** + * @param config Marian yml config file in the form of a string + * @param model_memory byte array (aligned to 64!!!) that contains the bytes of a model.bin. Optional, defaults to nullptr when not used + */ std::shared_ptr -AbstractTranslationModel::createInstance(const std::string &config) { - return std::make_shared(config); +AbstractTranslationModel::createInstance(const std::string &config, const void * model_memory) { + return std::make_shared(config, model_memory); } diff --git a/src/translator/CMakeLists.txt b/src/translator/CMakeLists.txt index 5c7269e..d149c03 100644 --- a/src/translator/CMakeLists.txt +++ b/src/translator/CMakeLists.txt @@ -7,6 +7,7 @@ add_library(bergamot-translator STATIC TranslationModel.cpp # Following files added from browsermt/mts@nuke + byteArrayExample.cpp text_processor.cpp sentence_splitter.cpp batch_translator.cpp diff --git a/src/translator/TranslationModel.cpp b/src/translator/TranslationModel.cpp index b3e0db6..94f53a8 100644 --- a/src/translator/TranslationModel.cpp +++ b/src/translator/TranslationModel.cpp @@ -50,9 +50,9 @@ std::shared_ptr parseOptions(const std::string &config) { return std::make_shared(options); } -TranslationModel::TranslationModel(const std::string &config) +TranslationModel::TranslationModel(const std::string &config, const void * model_memory) : configOptions_(std::move(parseOptions(config))), - AbstractTranslationModel(), service_(configOptions_) {} + AbstractTranslationModel(), service_(configOptions_, model_memory) {} TranslationModel::~TranslationModel() {} diff --git a/src/translator/TranslationModel.h b/src/translator/TranslationModel.h index e476596..92fca63 100644 --- a/src/translator/TranslationModel.h +++ b/src/translator/TranslationModel.h @@ -27,7 +27,11 @@ public: /* Construct the model using the model configuration options as yaml-formatted * string */ - TranslationModel(const std::string &config); + /** + * @param config Marian yml config file in the form of a string + * @param model_memory optional byte array (aligned to 64!!!) that contains the bytes of a model.bin. + */ + TranslationModel(const std::string &config, const void * model_memory = nullptr); ~TranslationModel(); diff --git a/src/translator/batch_translator.cpp b/src/translator/batch_translator.cpp index 6036c37..c83cf8c 100644 --- a/src/translator/batch_translator.cpp +++ b/src/translator/batch_translator.cpp @@ -10,8 +10,9 @@ namespace bergamot { BatchTranslator::BatchTranslator(DeviceId const device, std::vector> &vocabs, - Ptr options) - : device_(device), options_(options), vocabs_(&vocabs) {} + Ptr options, + const void * model_memory) + : device_(device), options_(options), vocabs_(&vocabs), model_memory_(model_memory) {} void BatchTranslator::initialize() { // Initializes the graph. @@ -29,7 +30,16 @@ void BatchTranslator::initialize() { graph_->setDevice(device_); graph_->getBackend()->configureDevice(options_); graph_->reserveWorkspaceMB(options_->get("workspace")); - scorers_ = createScorers(options_); + if (model_memory_) { // If we have provided a byte array that contains the model memory, we can initialise the model from there, as opposed to from reading in the config file + if ((uintptr_t)model_memory_ % 256 != 0) { + std::cerr << "The provided memory is not aligned to 256 bytes and will crash when vector instructions are used on it." << std::endl; + exit(1); + } + const std::vector container = {model_memory_}; // Marian supports multiple models initialised in this manner hence std::vector. However we will only ever use 1 during decoding. + scorers_ = createScorers(options_, container); + } else { + scorers_ = createScorers(options_); + } for (auto scorer : scorers_) { scorer->init(graph_); if (slgen_) { diff --git a/src/translator/batch_translator.h b/src/translator/batch_translator.h index 50a7b79..683c279 100644 --- a/src/translator/batch_translator.h +++ b/src/translator/batch_translator.h @@ -26,8 +26,15 @@ class BatchTranslator { // shut down in Service which calls join() on the threads. public: - BatchTranslator(DeviceId const device, std::vector> &vocabs, - Ptr options); + /** + * Initialise the marian translator. + * @param device DeviceId that performs translation. Could be CPU or GPU + * @param vocabs Vector that contains ptrs to two vocabs + * @param options Marian options object + * @param model_memory byte array (aligned to 64!!!) that contains the bytes of a model.bin. Provide a nullptr if not used. + */ + explicit BatchTranslator(DeviceId const device, std::vector> &vocabs, + Ptr options, const void * model_memory); // convenience function for logging. TODO(jerin) std::string _identifier() { return "worker" + std::to_string(device_.no); } @@ -41,6 +48,7 @@ private: Ptr graph_; std::vector> scorers_; Ptr slgen_; + const void * model_memory_; }; } // namespace bergamot diff --git a/src/translator/byteArrayExample.cpp b/src/translator/byteArrayExample.cpp new file mode 100644 index 0000000..28f9d9b --- /dev/null +++ b/src/translator/byteArrayExample.cpp @@ -0,0 +1,45 @@ +#include "byteArrayExample.h" +#include +#include +#include + +namespace bergamot { + +void * getBinaryFile(std::string path) { + std::ifstream is (path, std::ifstream::binary); + uint64_t length = 0; // Determine the length of file in bytes + if (is) { + is.seekg(0, is.end); + length = is.tellg(); + is.seekg(0, is.beg); + } else { + std::cerr << "Failed opening file stream: " << path << std::endl; + std::exit(1); + } + void *result; + int fail = posix_memalign(&result, 256, length); + if (fail) { + std::cerr << "Failed to allocate aligned memory." << std::endl; + std::exit(1); + } + is.read(static_cast(result), length); + return result; +} + +void * getBinaryModelFromConfig(marian::Ptr options) { + std::vector models = options->get>("models"); + if (models.size() != 1) { + std::cerr << "Loading multiple binary models is not supported for now as it is not necessary." << std::endl; + std::exit(1); + marian::filesystem::Path modelPath(models[0]); + if (modelPath.extension() != marian::filesystem::Path(".bin")) { + std::cerr << "Non binary models cannot be loaded as a byte array." << std::endl; + std::exit(1); + } + return nullptr; + } else { + return getBinaryFile(models[0]); + } +} + +} // namespace bergamot diff --git a/src/translator/byteArrayExample.h b/src/translator/byteArrayExample.h new file mode 100644 index 0000000..321ea5d --- /dev/null +++ b/src/translator/byteArrayExample.h @@ -0,0 +1,8 @@ +#include "marian.h" + +namespace bergamot { + +void * getBinaryFile(std::string path); +void * getBinaryModelFromConfig(marian::Ptr options); + +} // namespace bergamot diff --git a/src/translator/service.cpp b/src/translator/service.cpp index 2101b8e..86e8c59 100644 --- a/src/translator/service.cpp +++ b/src/translator/service.cpp @@ -8,9 +8,9 @@ namespace marian { namespace bergamot { -Service::Service(Ptr options) +Service::Service(Ptr options, const void * model_memory) : ServiceBase(options), numWorkers_(options->get("cpu-threads")), - pcqueue_(numWorkers_) { + pcqueue_(numWorkers_), model_memory_{model_memory} { if (numWorkers_ == 0) { ABORT("Fatal: Attempt to create multithreaded instance with --cpu-threads " "0. "); @@ -21,7 +21,7 @@ Service::Service(Ptr options) for (size_t cpuId = 0; cpuId < numWorkers_; cpuId++) { marian::DeviceId deviceId(cpuId, DeviceType::cpu); - translators_.emplace_back(deviceId, vocabs_, options); + translators_.emplace_back(deviceId, vocabs_, options, model_memory_); auto &translator = translators_.back(); workers_.emplace_back([&translator, this] { diff --git a/src/translator/service.h b/src/translator/service.h index 9a57996..38de3ae 100644 --- a/src/translator/service.h +++ b/src/translator/service.h @@ -31,7 +31,11 @@ class Service : public ServiceBase { // Response result = response.get(); public: - explicit Service(Ptr options); + /** + * @param options Marian options object + * @param model_memory byte array (aligned to 64!!!) that contains the bytes of a model.bin. Optional, defaults to nullptr when not used + */ + explicit Service(Ptr options, const void * model_memory=nullptr); // Implements enqueue and top through blocking methods. void stop() override; ~Service(); @@ -46,6 +50,7 @@ private: size_t numWorkers_; // ORDER DEPENDENCY PCQueue pcqueue_; // ORDER DEPENDENCY + const void * model_memory_; std::vector workers_; std::vector translators_; }; diff --git a/src/translator/service_base.cpp b/src/translator/service_base.cpp index 1a5f511..dc0c05a 100644 --- a/src/translator/service_base.cpp +++ b/src/translator/service_base.cpp @@ -24,9 +24,9 @@ std::future ServiceBase::translate(std::string &&input) { return future; } -NonThreadedService::NonThreadedService(Ptr options) +NonThreadedService::NonThreadedService(Ptr options, const void * model_memory) : ServiceBase(options), - translator_(DeviceId(0, DeviceType::cpu), vocabs_, options) { + translator_(DeviceId(0, DeviceType::cpu), vocabs_, options, model_memory) { translator_.initialize(); } diff --git a/src/translator/service_base.h b/src/translator/service_base.h index 25cc003..a44273f 100644 --- a/src/translator/service_base.h +++ b/src/translator/service_base.h @@ -16,6 +16,9 @@ namespace bergamot { class ServiceBase { public: + /** + * @param options Marian options object + */ explicit ServiceBase(Ptr options); // Transfers ownership of input string to Service, returns a future containing @@ -44,7 +47,11 @@ protected: class NonThreadedService : public ServiceBase { public: - explicit NonThreadedService(Ptr options); + /** + * @param options Marian options object + * @param model_memory byte array (aligned to 64!!!) that contains the bytes of a model.bin. Provide a nullptr if not used. + */ + explicit NonThreadedService(Ptr options, const void * model_memory); void stop() override{}; private: From 34228d37bfcc44e36bf01d8ea70fbc2fce9d9ae9 Mon Sep 17 00:00:00 2001 From: Jerin Philip Date: Tue, 23 Mar 2021 16:36:13 +0000 Subject: [PATCH 03/19] Collapse Service into one class instead of three (#62) * Merging two Services * Moving stop() logic to destructor * We have WITH_PTHREADS back * string based constructor on Service * Removing now empty service_base.* files * Hiding away pcqueue_ construction Ugliest ifdefs I have done in my life. * Another ifdef to hide pcqueue header file * Missing semicolons in WITH_PTHREADS path * Fixing async_translate residue argument from copy * Adding comments * Initialize batchtranslator only at one place To reduce tax for bytebuffer loads, initialize batchtranslator only at one place. * \#ifdef WITH_PTHREADS -> #ifndef WASM_HIDE_THREADS Sane platform (non WASM) is default. This truly only hide-threads from compilation path and not switch unswitch pthreads (-lpthread). * Review comments: Rearranging destructor, fix wrong comment * Move loadVocabularies to service.cpp and put in anonymous namespace * Prettifying diff: Removing unwanted empty lines * Indicate in comments multithreaded has numWorkers translators * Typo fix: bergamot_translator -> bergamot-translator * Safety guards to avoid pcqueue illegal init * Add WASM_HIDE_THREADS as a global WASM_COMPILE_FLAG * Compile Defs: WASM_HIDE_THREADS -> __EMSCRIPTEN__ * Removing dead CMakeLists.txt code following __EMSCRIPTEN__ * Compile defs: __EMSCRIPTEN__ -> WASM --- app/marian-decoder-new.cpp | 1 - app/service-cli-bytearray.cpp | 3 - app/service-cli.cpp | 2 - src/translator/CMakeLists.txt | 8 +- src/translator/TranslationModel.cpp | 47 +---------- src/translator/TranslationModel.h | 10 ++- src/translator/batch_translator.h | 2 +- src/translator/batcher.h | 2 +- src/translator/parser.h | 38 +++++++++ src/translator/service.cpp | 125 ++++++++++++++++++++++----- src/translator/service.h | 126 +++++++++++++++++++++------- src/translator/service_base.cpp | 42 ---------- src/translator/service_base.h | 87 ------------------- 13 files changed, 248 insertions(+), 245 deletions(-) delete mode 100644 src/translator/service_base.cpp delete mode 100644 src/translator/service_base.h diff --git a/app/marian-decoder-new.cpp b/app/marian-decoder-new.cpp index f807909..dea49eb 100644 --- a/app/marian-decoder-new.cpp +++ b/app/marian-decoder-new.cpp @@ -56,6 +56,5 @@ int main(int argc, char *argv[]) { marian_decoder_minimal(response.histories(), service.targetVocab(), options); LOG(info, "Total time: {:.5f}s wall", decoderTimer.elapsed()); - service.stop(); return 0; } diff --git a/app/service-cli-bytearray.cpp b/app/service-cli-bytearray.cpp index 42a2af3..d967810 100644 --- a/app/service-cli-bytearray.cpp +++ b/app/service-cli-bytearray.cpp @@ -30,9 +30,6 @@ int main(int argc, char *argv[]) { Response response = responseFuture.get(); std::cout << response.translation() << std::endl; - // Stop Service. - service.stop(); - // Clear the memory used for the byte array free(model_bytes); // Ideally, this should be done after the translation model has been gracefully shut down. diff --git a/app/service-cli.cpp b/app/service-cli.cpp index a8382b2..2bb825c 100644 --- a/app/service-cli.cpp +++ b/app/service-cli.cpp @@ -27,7 +27,5 @@ int main(int argc, char *argv[]) { Response response = responseFuture.get(); std::cout << response.translation() << std::endl; - // Stop Service. - service.stop(); return 0; } diff --git a/src/translator/CMakeLists.txt b/src/translator/CMakeLists.txt index d149c03..ae38f9b 100644 --- a/src/translator/CMakeLists.txt +++ b/src/translator/CMakeLists.txt @@ -1,24 +1,18 @@ -if (NOT USE_WASM_COMPATIBLE_SOURCES) - set(MULTITHREADED_SERVICE_SOURCE "service.cpp") -endif() - add_library(bergamot-translator STATIC AbstractTranslationModel.cpp TranslationModel.cpp - # Following files added from browsermt/mts@nuke byteArrayExample.cpp text_processor.cpp sentence_splitter.cpp batch_translator.cpp multifactor_priority.cpp request.cpp - service_base.cpp - ${MULTITHREADED_SERVICE_SOURCE} batcher.cpp response.cpp batch.cpp sentence_ranges.cpp + service.cpp ) if (COMPILE_DECODER_ONLY) # A dirty hack because of marian's bad cmake practices diff --git a/src/translator/TranslationModel.cpp b/src/translator/TranslationModel.cpp index 94f53a8..715df47 100644 --- a/src/translator/TranslationModel.cpp +++ b/src/translator/TranslationModel.cpp @@ -6,53 +6,14 @@ #include #include -// All 3rd party includes -#include "3rd_party/marian-dev/src/3rd_party/yaml-cpp/yaml.h" -#include "3rd_party/marian-dev/src/common/config_parser.h" -#include "common/config_validator.h" -#include "common/options.h" - // All local project includes #include "TranslationModel.h" #include "translator/parser.h" -#include "translator/service_base.h" +#include "translator/service.h" -std::shared_ptr parseOptions(const std::string &config) { - marian::Options options; - - // @TODO(jerinphilip) There's something off here, @XapaJIaMnu suggests - // that should not be using the defaultConfig. This function only has access - // to std::string config and needs to be able to construct Options from the - // same. - - // Absent the following code-segment, there is a parsing exception thrown on - // rebuilding YAML. - // - // Error: Unhandled exception of type 'N4YAML11InvalidNodeE': invalid node; - // this may result from using a map iterator as a sequence iterator, or - // vice-versa - // - // Error: Aborted from void unhandledException() in - // 3rd_party/marian-dev/src/common/logging.cpp:113 - - marian::ConfigParser configParser = marian::bergamot::createConfigParser(); - const YAML::Node &defaultConfig = configParser.getConfig(); - - options.merge(defaultConfig); - - // Parse configs onto defaultConfig. - options.parse(config); - YAML::Node configCopy = options.cloneToYamlNode(); - - marian::ConfigValidator validator(configCopy); - validator.validateOptions(marian::cli::mode::translation); - - return std::make_shared(options); -} - -TranslationModel::TranslationModel(const std::string &config, const void * model_memory) - : configOptions_(std::move(parseOptions(config))), - AbstractTranslationModel(), service_(configOptions_, model_memory) {} +TranslationModel::TranslationModel(const std::string &config, + const void *model_memory) + : AbstractTranslationModel(), service_(config, model_memory) {} TranslationModel::~TranslationModel() {} diff --git a/src/translator/TranslationModel.h b/src/translator/TranslationModel.h index 92fca63..224d6b0 100644 --- a/src/translator/TranslationModel.h +++ b/src/translator/TranslationModel.h @@ -16,7 +16,7 @@ // All local project includes #include "AbstractTranslationModel.h" -#include "translator/service_base.h" +#include "translator/service.h" /* A Translation model that translates a plain (without any markups and emojis) * UTF-8 encoded text. This implementation supports translation from 1 source @@ -29,9 +29,11 @@ public: */ /** * @param config Marian yml config file in the form of a string - * @param model_memory optional byte array (aligned to 64!!!) that contains the bytes of a model.bin. + * @param model_memory optional byte array (aligned to 64!!!) that contains + * the bytes of a model.bin. */ - TranslationModel(const std::string &config, const void * model_memory = nullptr); + TranslationModel(const std::string &config, + const void *model_memory = nullptr); ~TranslationModel(); @@ -69,7 +71,7 @@ public: private: // Model configuration options std::shared_ptr configOptions_; // ORDER DEPENDECNY - marian::bergamot::NonThreadedService service_; // ORDER DEPENDENCY + marian::bergamot::Service service_; // ORDER DEPENDENCY }; #endif /* SRC_TRANSLATOR_TRANSLATIONMODEL_H_ */ diff --git a/src/translator/batch_translator.h b/src/translator/batch_translator.h index 683c279..c920945 100644 --- a/src/translator/batch_translator.h +++ b/src/translator/batch_translator.h @@ -12,7 +12,7 @@ #include "translator/history.h" #include "translator/scorers.h" -#ifdef WITH_PTHREADS +#ifndef WASM #include "pcqueue.h" #endif diff --git a/src/translator/batcher.h b/src/translator/batcher.h index 81ed2d2..675cd59 100644 --- a/src/translator/batcher.h +++ b/src/translator/batcher.h @@ -7,7 +7,7 @@ #include "definitions.h" #include "request.h" -#ifdef WITH_PTHREADS +#ifndef WASM #include "pcqueue.h" #endif diff --git a/src/translator/parser.h b/src/translator/parser.h index 7fb53e1..4d93e3a 100644 --- a/src/translator/parser.h +++ b/src/translator/parser.h @@ -1,6 +1,10 @@ #ifndef SRC_BERGAMOT_PARSER_H #define SRC_BERGAMOT_PARSER_H +#include "3rd_party/yaml-cpp/yaml.h" +#include "common/config_parser.h" +#include "common/config_validator.h" +#include "common/options.h" #include "marian.h" namespace marian { @@ -22,6 +26,40 @@ inline marian::ConfigParser createConfigParser() { return cp; } +inline std::shared_ptr +parseOptions(const std::string &config) { + marian::Options options; + + // @TODO(jerinphilip) There's something off here, @XapaJIaMnu suggests + // that should not be using the defaultConfig. This function only has access + // to std::string config and needs to be able to construct Options from the + // same. + + // Absent the following code-segment, there is a parsing exception thrown on + // rebuilding YAML. + // + // Error: Unhandled exception of type 'N4YAML11InvalidNodeE': invalid node; + // this may result from using a map iterator as a sequence iterator, or + // vice-versa + // + // Error: Aborted from void unhandledException() in + // 3rd_party/marian-dev/src/common/logging.cpp:113 + + marian::ConfigParser configParser = createConfigParser(); + const YAML::Node &defaultConfig = configParser.getConfig(); + + options.merge(defaultConfig); + + // Parse configs onto defaultConfig. + options.parse(config); + YAML::Node configCopy = options.cloneToYamlNode(); + + marian::ConfigValidator validator(configCopy); + validator.validateOptions(marian::cli::mode::translation); + + return std::make_shared(options); +} + } // namespace bergamot } // namespace marian diff --git a/src/translator/service.cpp b/src/translator/service.cpp index 86e8c59..8c8c453 100644 --- a/src/translator/service.cpp +++ b/src/translator/service.cpp @@ -5,25 +5,77 @@ #include #include +inline std::vector> +loadVocabularies(marian::Ptr options) { + // @TODO: parallelize vocab loading for faster startup + auto vfiles = options->get>("vocabs"); + // with the current setup, we need at least two vocabs: src and trg + ABORT_IF(vfiles.size() < 2, "Insufficient number of vocabularies."); + std::vector> vocabs(vfiles.size()); + std::unordered_map> vmap; + for (size_t i = 0; i < vocabs.size(); ++i) { + auto m = + vmap.emplace(std::make_pair(vfiles[i], marian::Ptr())); + if (m.second) { // new: load the vocab + m.first->second = marian::New(options, i); + m.first->second->load(vfiles[i]); + } + vocabs[i] = m.first->second; + } + return vocabs; +} + namespace marian { namespace bergamot { -Service::Service(Ptr options, const void * model_memory) - : ServiceBase(options), numWorkers_(options->get("cpu-threads")), - pcqueue_(numWorkers_), model_memory_{model_memory} { - if (numWorkers_ == 0) { - ABORT("Fatal: Attempt to create multithreaded instance with --cpu-threads " - "0. "); - } +Service::Service(Ptr options, const void *model_memory) + : requestId_(0), vocabs_(std::move(loadVocabularies(options))), + text_processor_(vocabs_, options), batcher_(options), + numWorkers_(options->get("cpu-threads")), model_memory_(model_memory) +#ifndef WASM + // 0 elements in PCQueue is illegal and can lead to failures. Adding a + // guard to have at least one entry allocated. In the single-threaded + // case, while initialized pcqueue_ remains unused. + , + pcqueue_(std::max(1, numWorkers_)) +#endif +{ - translators_.reserve(numWorkers_); + if (numWorkers_ == 0) { + build_translators(options, /*numTranslators=*/1); + initialize_blocking_translator(); + } else { + build_translators(options, numWorkers_); + initialize_async_translators(); + } +} + +void Service::build_translators(Ptr options, size_t numTranslators) { + translators_.reserve(numTranslators); + for (size_t cpuId = 0; cpuId < numTranslators; cpuId++) { + marian::DeviceId deviceId(cpuId, DeviceType::cpu); + translators_.emplace_back(deviceId, vocabs_, options, model_memory_); + } +} + +void Service::initialize_blocking_translator() { + translators_.back().initialize(); +} + +void Service::blocking_translate() { + Batch batch; + while (batcher_ >> batch) { + auto &translator = translators_.back(); + translator.translate(batch); + } +} + +#ifndef WASM +void Service::initialize_async_translators() { workers_.reserve(numWorkers_); for (size_t cpuId = 0; cpuId < numWorkers_; cpuId++) { - marian::DeviceId deviceId(cpuId, DeviceType::cpu); - translators_.emplace_back(deviceId, vocabs_, options, model_memory_); - auto &translator = translators_.back(); - + auto &translator = translators_[cpuId]; workers_.emplace_back([&translator, this] { translator.initialize(); @@ -42,29 +94,58 @@ Service::Service(Ptr options, const void * model_memory) } } -void Service::enqueue() { +void Service::async_translate() { Batch batch; while (batcher_ >> batch) { pcqueue_.ProduceSwap(batch); } } +#else // WASM +void Service::initialize_async_translators() { + ABORT("Cannot run in async mode without multithreading."); +} + +void Service::async_translate() { + ABORT("Cannot run in async mode without multithreading."); +} +#endif // WASM + +std::future Service::translate(std::string &&input) { + Segments segments; + SentenceRanges sourceRanges; + text_processor_.process(input, segments, sourceRanges); + + std::promise responsePromise; + auto future = responsePromise.get_future(); + + Ptr request = New( + requestId_++, /* lineNumberBegin = */ 0, vocabs_, std::move(input), + std::move(segments), std::move(sourceRanges), std::move(responsePromise)); + + batcher_.addWholeRequest(request); + if (numWorkers_ == 0) { + blocking_translate(); + } else { + async_translate(); + } + return future; +} + +Service::~Service() { +#ifndef WASM + for (size_t workerId = 0; workerId < numWorkers_; workerId++) { -void Service::stop() { - for (auto &worker : workers_) { Batch poison = Batch::poison(); pcqueue_.ProduceSwap(poison); } - for (auto &worker : workers_) { - if (worker.joinable()) { - worker.join(); + for (size_t workerId = 0; workerId < numWorkers_; workerId++) { + if (workers_[workerId].joinable()) { + workers_[workerId].join(); } } - - workers_.clear(); +#endif } -Service::~Service() { stop(); } - } // namespace bergamot } // namespace marian diff --git a/src/translator/service.h b/src/translator/service.h index 38de3ae..bb8dbe9 100644 --- a/src/translator/service.h +++ b/src/translator/service.h @@ -4,10 +4,13 @@ #include "batch_translator.h" #include "batcher.h" #include "data/types.h" -#include "pcqueue.h" #include "response.h" -#include "service_base.h" #include "text_processor.h" +#include "translator/parser.h" + +#ifndef WASM +#include "pcqueue.h" +#endif #include #include @@ -15,44 +18,103 @@ namespace marian { namespace bergamot { -class Service : public ServiceBase { - - // Service exposes methods to translate an incoming blob of text to the - // Consumer of bergamot API. - // - // An example use of this API looks as follows: - // - // options = ...; - // service = Service(options); - // std::string input_blob = "Hello World"; - // std::future - // response = service.translate(std::move(input_blob)); - // response.wait(); - // Response result = response.get(); +/// Service exposes methods to translate an incoming blob of text to the +/// Consumer of bergamot API. +/// +/// An example use of this API looks as follows: +/// +/// options = ...; +/// service = Service(options); +/// std::string input_blob = "Hello World"; +/// std::future +/// response = service.translate(std::move(input_blob)); +/// response.wait(); +/// Response result = response.get(); +/// +/// Optionally Service can be initialized by also passing model_memory for +/// purposes of efficiency (which defaults to nullpointer and then reads from +/// file supplied through config). +class Service { public: - /** - * @param options Marian options object - * @param model_memory byte array (aligned to 64!!!) that contains the bytes of a model.bin. Optional, defaults to nullptr when not used - */ - explicit Service(Ptr options, const void * model_memory=nullptr); - // Implements enqueue and top through blocking methods. - void stop() override; + /// @param options Marian options object + /// @param model_memory byte array (aligned to 64!!!) that contains the bytes + /// of a model.bin. Optional, defaults to nullptr when not used + explicit Service(Ptr options, const void *model_memory = nullptr); + + /// Construct Service from a string configuration. + /// @param [in] config string parsable as YAML expected to adhere with marian + /// config + /// @param [in] model_memory byte array (aligned to 64!!!) that contains the + /// bytes of a model.bin. Optional, defaults to nullptr when not used + explicit Service(const std::string &config, + const void *model_memory = nullptr) + : Service(parseOptions(config), model_memory) {} + + /// Explicit destructor to clean up after any threads initialized in + /// asynchronous operation mode. ~Service(); + /// Shared pointer to source-vocabulary. + Ptr sourceVocab() const { return vocabs_.front(); } + + /// Shared pointer to target vocabulary. + Ptr targetVocab() const { return vocabs_.back(); } + + /// To stay efficient and to refer to the string for alignments, expects + /// ownership be moved through std::move(..) + /// + /// @param [in] rvalue reference of string to be translated. + std::future translate(std::string &&input); + private: - void enqueue() override; + /// Build numTranslators number of translators with options from options + void build_translators(Ptr options, size_t numTranslators); + /// Initializes a blocking translator without using std::thread + void initialize_blocking_translator(); + /// Translates through direct interaction between batcher_ and translators_ + void blocking_translate(); - // In addition to the common members (text_processor, requestId, vocabs_, - // batcher) extends with a producer-consumer queue, vector of translator - // instances owned by service each listening to the pcqueue in separate - // threads. + /// Launches multiple workers of translators using std::thread + /// Reduces to ABORT if called when not compiled WITH_PTHREAD + void initialize_async_translators(); + /// Async translate produces to a producer-consumer queue as batches are + /// generated by Batcher. In another thread, the translators consume from + /// producer-consumer queue. + /// Reduces to ABORT if called when not compiled WITH_PTHREAD + void async_translate(); - size_t numWorkers_; // ORDER DEPENDENCY - PCQueue pcqueue_; // ORDER DEPENDENCY - const void * model_memory_; - std::vector workers_; + /// Number of workers to launch. + size_t numWorkers_; // ORDER DEPENDENCY (pcqueue_) + const void *model_memory_; /// Model memory to load model passed as bytes. + + /// Holds instances of batch translators, just one in case + /// of single-threaded application, numWorkers_ in case of multithreaded + /// setting. std::vector translators_; + + /// Stores requestId of active request. Used to establish + /// ordering among requests and logging/book-keeping. + + size_t requestId_; + + /// Store vocabs representing source and target. + std::vector> vocabs_; // ORDER DEPENDENCY (text_processor_) + + /// TextProcesser takes a blob of text and converts into format consumable by + /// the batch-translator and annotates sentences and words. + TextProcessor text_processor_; // ORDER DEPENDENCY (vocabs_) + + /// Batcher handles generation of batches from a request, subject to + /// packing-efficiency and priority optimization heuristics. + Batcher batcher_; + + // The following constructs are available providing full capabilities on a non + // WASM platform, where one does not have to hide threads. +#ifndef WASM + PCQueue pcqueue_; // ORDER DEPENDENCY (numWorkers_) + std::vector workers_; +#endif // WASM }; } // namespace bergamot diff --git a/src/translator/service_base.cpp b/src/translator/service_base.cpp deleted file mode 100644 index dc0c05a..0000000 --- a/src/translator/service_base.cpp +++ /dev/null @@ -1,42 +0,0 @@ -#include "service_base.h" - -namespace marian { -namespace bergamot { - -ServiceBase::ServiceBase(Ptr options) - : requestId_(0), vocabs_(std::move(loadVocabularies(options))), - text_processor_(vocabs_, options), batcher_(options) {} - -std::future ServiceBase::translate(std::string &&input) { - Segments segments; - SentenceRanges sourceRanges; - text_processor_.process(input, segments, sourceRanges); - - std::promise responsePromise; - auto future = responsePromise.get_future(); - - Ptr request = New( - requestId_++, /* lineNumberBegin = */ 0, vocabs_, std::move(input), - std::move(segments), std::move(sourceRanges), std::move(responsePromise)); - - batcher_.addWholeRequest(request); - enqueue(); - return future; -} - -NonThreadedService::NonThreadedService(Ptr options, const void * model_memory) - : ServiceBase(options), - translator_(DeviceId(0, DeviceType::cpu), vocabs_, options, model_memory) { - translator_.initialize(); -} - -void NonThreadedService::enqueue() { - // Queue single-threaded - Batch batch; - while (batcher_ >> batch) { - translator_.translate(batch); - } -} - -} // namespace bergamot -} // namespace marian diff --git a/src/translator/service_base.h b/src/translator/service_base.h deleted file mode 100644 index a44273f..0000000 --- a/src/translator/service_base.h +++ /dev/null @@ -1,87 +0,0 @@ -#ifndef SRC_BERGAMOT_SERVICE_BASE_H_ -#define SRC_BERGAMOT_SERVICE_BASE_H_ -#include "batch_translator.h" -#include "batcher.h" -#include "data/types.h" -#include "response.h" -#include "text_processor.h" - -#include -#include - -namespace marian { -namespace bergamot { -// This file describes the base class ServiceBase, and a non-threaded subclass -// implementing translation functionality called NonThreadedService. - -class ServiceBase { -public: - /** - * @param options Marian options object - */ - explicit ServiceBase(Ptr options); - - // Transfers ownership of input string to Service, returns a future containing - // an object which provides access to translations, other features like - // sentencemappings and (tentatively) alignments. - std::future translate(std::string &&input); - - // Convenience accessor methods to extract these vocabulary outside service. - // e.g: For use in decoding histories for marian-decoder replacement. - Ptr sourceVocab() const { return vocabs_.front(); } - Ptr targetVocab() const { return vocabs_.back(); } - - // Wraps up any thread related destruction code. - virtual void stop() = 0; - -protected: - // Enqueue queues a request for translation, this can be synchronous, blocking - // or asynchronous and queued in the background. - virtual void enqueue() = 0; - - size_t requestId_; - std::vector> vocabs_; // ORDER DEPENDENCY - TextProcessor text_processor_; // ORDER DEPENDENCY - Batcher batcher_; -}; - -class NonThreadedService : public ServiceBase { -public: - /** - * @param options Marian options object - * @param model_memory byte array (aligned to 64!!!) that contains the bytes of a model.bin. Provide a nullptr if not used. - */ - explicit NonThreadedService(Ptr options, const void * model_memory); - void stop() override{}; - -private: - // NonThreaded service overrides unimplemented functions in base-class using - // blocking mechanisms. - void enqueue() override; - // There's a single translator, launched as part of the main process. - BatchTranslator translator_; -}; - -// Used across Services -inline std::vector> loadVocabularies(Ptr options) { - // @TODO: parallelize vocab loading for faster startup - auto vfiles = options->get>("vocabs"); - // with the current setup, we need at least two vocabs: src and trg - ABORT_IF(vfiles.size() < 2, "Insufficient number of vocabularies."); - std::vector> vocabs(vfiles.size()); - std::unordered_map> vmap; - for (size_t i = 0; i < vocabs.size(); ++i) { - auto m = vmap.emplace(std::make_pair(vfiles[i], Ptr())); - if (m.second) { // new: load the vocab - m.first->second = New(options, i); - m.first->second->load(vfiles[i]); - } - vocabs[i] = m.first->second; - } - return vocabs; -} - -} // namespace bergamot -} // namespace marian - -#endif // SRC_BERGAMOT_SERVICE_BASE_H_ From 12e9232066d074f65cdb8642a4eac96ee3978ead Mon Sep 17 00:00:00 2001 From: abhi-agg <66322306+abhi-agg@users.noreply.github.com> Date: Wed, 24 Mar 2021 17:10:42 +0100 Subject: [PATCH 04/19] Patch WASM artifacts to run optimized (wormhole enabled) inference (#68) * A script to patch the wasm artifacts to use wormhole via APIs that instantiate WASM module * Updated README * Load just production ready models * Shallow clone bergamot-models repo since it has such a large history * Improved wasm test_page - test page can load all 5 language pairs - Use intgemm.alpha* models * Refactor the code that patches wasm artifacts to enable wormhole Co-authored-by: Andre Natal Co-authored-by: Motin --- .github/workflows/macos-custom-marian-wasm.yml | 4 ++++ README.md | 15 ++++++++++----- wasm/patch-artifacts-enable-wormhole.sh | 7 +++++++ wasm/test_page/bergamot.html | 5 ++++- wasm/test_page/start_server.sh | 4 +++- 5 files changed, 28 insertions(+), 7 deletions(-) create mode 100644 wasm/patch-artifacts-enable-wormhole.sh diff --git a/.github/workflows/macos-custom-marian-wasm.yml b/.github/workflows/macos-custom-marian-wasm.yml index 3e49369..00f5cf7 100644 --- a/.github/workflows/macos-custom-marian-wasm.yml +++ b/.github/workflows/macos-custom-marian-wasm.yml @@ -33,6 +33,10 @@ jobs: working-directory: build-wasm run: emmake make -j2 + - name: Instantiate simd wormhole + working-directory: build-wasm + run: bash ../wasm/patch-artifacts-enable-wormhole.sh + - name: Check artifacts working-directory: build-wasm run: | diff --git a/README.md b/README.md index 2b7f0a6..e70e8cd 100644 --- a/README.md +++ b/README.md @@ -46,8 +46,8 @@ Bergamot translator provides a unified API for ([Marian NMT](https://marian-nmt. If you want to package bergamot project specific models, please follow these instructions: ```bash mkdir models - git clone https://github.com/mozilla-applied-ml/bergamot-models - cp -rf bergamot-models/* models + git clone --depth 1 --branch main --single-branch https://github.com/mozilla-applied-ml/bergamot-models + cp -rf bergamot-models/prod/* models gunzip models/*/* ``` @@ -75,11 +75,16 @@ Bergamot translator provides a unified API for ([Marian NMT](https://marian-nmt. emmake make -j ``` - The artefacts (.js and .wasm files) will be available in `wasm` folder of build directory ("build-wasm" in this case). + The wasm artifacts (.js and .wasm files) will be available in `wasm` folder of build directory ("build-wasm" in this case). + + 3. Enable SIMD Wormhole via Wasm instantiation API in generated artifacts + ```bash + bash ../wasm/patch-artifacts-enable-wormhole.sh + ``` #### Recompiling -As long as you don't update any submodule, just follow steps in `4.ii` to recompile.\ -If you update a submodule, execute following command before executing steps in `4.ii` to recompile. +As long as you don't update any submodule, just follow steps in `4.ii` and `4.iii` to recompile.\ +If you update a submodule, execute following command before executing steps in `4.ii` and `4.iii` to recompile. ```bash git submodule update --init --recursive ``` diff --git a/wasm/patch-artifacts-enable-wormhole.sh b/wasm/patch-artifacts-enable-wormhole.sh new file mode 100644 index 0000000..c16ba66 --- /dev/null +++ b/wasm/patch-artifacts-enable-wormhole.sh @@ -0,0 +1,7 @@ +#!/bin/bash + +echo "Patching wasm artifacts to enable wormhole via APIs that compile and instantiate wasm module" +sed -i.bak 's/var result = WebAssembly.instantiateStreaming(response, info);/var result = WebAssembly.instantiateStreaming(response, info, {simdWormhole:true});/g' wasm/bergamot-translator-worker.js +sed -i.bak 's/return WebAssembly.instantiate(binary, info);/return WebAssembly.instantiate(binary, info, {simdWormhole:true});/g' wasm/bergamot-translator-worker.js +sed -i.bak 's/var module = new WebAssembly.Module(bytes);/var module = new WebAssembly.Module(bytes, {simdWormhole:true});/g' wasm/bergamot-translator-worker.js +echo "Done" diff --git a/wasm/test_page/bergamot.html b/wasm/test_page/bergamot.html index b4d2027..4f1f2a0 100644 --- a/wasm/test_page/bergamot.html +++ b/wasm/test_page/bergamot.html @@ -32,6 +32,9 @@ + + + @@ -70,7 +73,7 @@ En consecuencia, durante el año 2011 se introdujeron 180 proyectos de ley que r // Set the Model Configuration as YAML formatted string. // For available configuration options, please check: https://marian-nmt.github.io/docs/cmd/marian-decoder/ const modelConfig = `models: - - /${languagePair}/model.${languagePair}.npz + - /${languagePair}/model.${languagePair}.intgemm.alphas.bin vocabs: - /${vocabLanguagePair}/vocab.${vocabLanguagePair}.spm - /${vocabLanguagePair}/vocab.${vocabLanguagePair}.spm diff --git a/wasm/test_page/start_server.sh b/wasm/test_page/start_server.sh index b83344b..b6fc2a6 100644 --- a/wasm/test_page/start_server.sh +++ b/wasm/test_page/start_server.sh @@ -1,8 +1,10 @@ #!/bin/bash - +echo "Start: Copying artifacts in local folder------" cp ../../build-wasm/wasm/bergamot-translator-worker.data . cp ../../build-wasm/wasm/bergamot-translator-worker.js . cp ../../build-wasm/wasm/bergamot-translator-worker.wasm . cp ../../build-wasm/wasm/bergamot-translator-worker.worker.js . + npm install +echo "Start httpserver" node bergamot-httpserver.js \ No newline at end of file From a3250b401f6bfac49ec941b46ddb49c792f7ddd2 Mon Sep 17 00:00:00 2001 From: Jerin Philip Date: Wed, 24 Mar 2021 17:00:53 +0000 Subject: [PATCH 05/19] Marian compatible documentation tooling (#67) Adds doxygen configurations, additional sphinx which consumes the doxygen files to generate developer API, compatible with marian-nmt/marian-dev. --- BERGAMOT_VERSION | 1 + Doxyfile.in | 2494 ++++++++++++++++++++++++++++++++++++ doc/.gitignore | 4 + doc/README.md | 51 + doc/_static/css/custom.css | 4 + doc/conf.py | 120 ++ doc/index.rst | 38 + doc/make.bat | 35 + doc/marian-integration.md | 2 +- doc/references.bib | 0 doc/requirements.txt | 6 + 11 files changed, 2754 insertions(+), 1 deletion(-) create mode 100644 BERGAMOT_VERSION create mode 100644 Doxyfile.in create mode 100644 doc/.gitignore create mode 100644 doc/README.md create mode 100644 doc/_static/css/custom.css create mode 100644 doc/conf.py create mode 100644 doc/index.rst create mode 100644 doc/make.bat create mode 100644 doc/references.bib create mode 100644 doc/requirements.txt diff --git a/BERGAMOT_VERSION b/BERGAMOT_VERSION new file mode 100644 index 0000000..ae39fab --- /dev/null +++ b/BERGAMOT_VERSION @@ -0,0 +1 @@ +v0.0.0 diff --git a/Doxyfile.in b/Doxyfile.in new file mode 100644 index 0000000..88948e2 --- /dev/null +++ b/Doxyfile.in @@ -0,0 +1,2494 @@ +# Doxyfile 1.8.13 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "Bergamot Translator" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = build/doc + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 2 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 0. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 0 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = YES + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO, these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = src app + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f \ + *.for \ + *.tcl \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the +# cost of reduced performance. This can be particularly helpful with template +# rich C++ code for which doxygen's built-in parser lacks the necessary type +# information. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse-libclang=ON option for CMake. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /