From edd4e1168a56c88200b79003d85875a414dc344c Mon Sep 17 00:00:00 2001 From: lxning Date: Mon, 23 May 2022 15:40:24 -0700 Subject: [PATCH 001/118] add workaround solution from nvidia --- test/buildspec_gpu.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/test/buildspec_gpu.yml b/test/buildspec_gpu.yml index 300c560fa9..f52d245a4f 100644 --- a/test/buildspec_gpu.yml +++ b/test/buildspec_gpu.yml @@ -7,6 +7,9 @@ phases: runtime-versions: python: 3.8 commands: + - apt-key del 7fa2af80 + - apt-key adv --fetch-keys https://developer.download.nvidia.com/compute/cuda/repos/ubuntu2004/x86_64/3bf863cc.pub + - apt-key adv --fetch-keys https://developer.download.nvidia.com/compute/machine-learning/repos/ubuntu2004/x86_64/7fa2af80.pub - apt-get update - apt-get install sudo -y - curl -O https://bootstrap.pypa.io/get-pip.py && python get-pip.py From bb3ea61c51a070bddb8e484a9b6f9acaf8727449 Mon Sep 17 00:00:00 2001 From: lxning Date: Mon, 23 May 2022 15:56:39 -0700 Subject: [PATCH 002/118] add comments --- test/buildspec_gpu.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/test/buildspec_gpu.yml b/test/buildspec_gpu.yml index f52d245a4f..2cd31f84de 100644 --- a/test/buildspec_gpu.yml +++ b/test/buildspec_gpu.yml @@ -7,6 +7,7 @@ phases: runtime-versions: python: 3.8 commands: + # Workaround from https://github.com/NVIDIA/nvidia-docker/issues/1632 - apt-key del 7fa2af80 - apt-key adv --fetch-keys https://developer.download.nvidia.com/compute/cuda/repos/ubuntu2004/x86_64/3bf863cc.pub - apt-key adv --fetch-keys https://developer.download.nvidia.com/compute/machine-learning/repos/ubuntu2004/x86_64/7fa2af80.pub From 851327aff8f484af1c7e746037580bbc63c2e4aa Mon Sep 17 00:00:00 2001 From: lxning Date: Tue, 24 May 2022 15:28:21 -0700 Subject: [PATCH 003/118] expand runtimeType --- .../org/pytorch/serve/archive/model/Manifest.java | 6 +++++- .../pytorch/serve/ensemble/WorkflowManifest.java | 6 +++++- .../src/main/java/org/pytorch/serve/wlm/Model.java | 14 +++++++++++++- 3 files changed, 23 insertions(+), 3 deletions(-) diff --git a/frontend/archive/src/main/java/org/pytorch/serve/archive/model/Manifest.java b/frontend/archive/src/main/java/org/pytorch/serve/archive/model/Manifest.java index 1dc3fd31ab..580557938b 100644 --- a/frontend/archive/src/main/java/org/pytorch/serve/archive/model/Manifest.java +++ b/frontend/archive/src/main/java/org/pytorch/serve/archive/model/Manifest.java @@ -130,7 +130,11 @@ public enum RuntimeType { @SerializedName("python2") PYTHON2("python2"), @SerializedName("python3") - PYTHON3("python3"); + PYTHON3("python3"), + @SerializedName("libtorch_scripted_process") + LSP("libtorch_scripted_process"), + @SerializedName("libtorch_deploy_process") + LDP("libtorch_deploy_process"); String value; diff --git a/frontend/server/src/main/java/org/pytorch/serve/ensemble/WorkflowManifest.java b/frontend/server/src/main/java/org/pytorch/serve/ensemble/WorkflowManifest.java index a700919de5..b181d85ac8 100644 --- a/frontend/server/src/main/java/org/pytorch/serve/ensemble/WorkflowManifest.java +++ b/frontend/server/src/main/java/org/pytorch/serve/ensemble/WorkflowManifest.java @@ -121,7 +121,11 @@ public enum RuntimeType { @SerializedName("python2") PYTHON2("python2"), @SerializedName("python3") - PYTHON3("python3"); + PYTHON3("python3"), + @SerializedName("libtorch_scripted_process") + LSP("libtorch_scripted_process"), + @SerializedName("libtorch_deploy_process") + LDP("libtorch_deploy_process"); String value; diff --git a/frontend/server/src/main/java/org/pytorch/serve/wlm/Model.java b/frontend/server/src/main/java/org/pytorch/serve/wlm/Model.java index 370c3a40cf..1c1545d344 100644 --- a/frontend/server/src/main/java/org/pytorch/serve/wlm/Model.java +++ b/frontend/server/src/main/java/org/pytorch/serve/wlm/Model.java @@ -11,6 +11,7 @@ import java.util.concurrent.atomic.AtomicInteger; import java.util.concurrent.locks.ReentrantLock; import org.apache.commons.io.FilenameUtils; +import org.pytorch.serve.archive.model.Manifest; import org.pytorch.serve.archive.model.ModelArchive; import org.pytorch.serve.job.Job; import org.pytorch.serve.util.ConfigManager; @@ -29,6 +30,7 @@ public class Model { public static final String RESPONSE_TIMEOUT = "responseTimeout"; public static final String DEFAULT_VERSION = "defaultVersion"; public static final String MAR_NAME = "marName"; + public static final String RUNTIME_TYPE = "runtimeType"; private static final Logger logger = LoggerFactory.getLogger(Model.class); @@ -40,8 +42,8 @@ public class Model { private ReentrantLock lock; private int responseTimeout; private ModelVersionName modelVersionName; - private boolean isWorkflowModel; + private Manifest.RuntimeType runtimeType; // Total number of subsequent inference request failures private AtomicInteger failedInfReqs; @@ -73,6 +75,7 @@ public JsonObject getModelState(boolean isDefaultVersion) { modelInfo.addProperty(BATCH_SIZE, getBatchSize()); modelInfo.addProperty(MAX_BATCH_DELAY, getMaxBatchDelay()); modelInfo.addProperty(RESPONSE_TIMEOUT, getResponseTimeout()); + modelInfo.addProperty(RUNTIME_TYPE, getRuntimeType().getValue()); return modelInfo; } @@ -83,6 +86,7 @@ public void setModelState(JsonObject modelInfo) { maxBatchDelay = modelInfo.get(MAX_BATCH_DELAY).getAsInt(); responseTimeout = modelInfo.get(RESPONSE_TIMEOUT).getAsInt(); batchSize = modelInfo.get(BATCH_SIZE).getAsInt(); + runtimeType = Manifest.RuntimeType.fromValue(modelInfo.get(RUNTIME_TYPE).getAsString()); } public String getModelName() { @@ -149,6 +153,14 @@ public void setWorkflowModel(boolean workflowModel) { isWorkflowModel = workflowModel; } + public Manifest.RuntimeType getRuntimeType() { + return this.runtimeType; + } + + public void setRuntimeType(String runtimeType) { + this.runtimeType = Manifest.RuntimeType.fromValue(runtimeType); + } + public void addJob(String threadId, Job job) { LinkedBlockingDeque blockingDeque = jobsDb.get(threadId); if (blockingDeque == null) { From bfaa0459a9b651d5b6788928407b41bc2b739b93 Mon Sep 17 00:00:00 2001 From: lxning Date: Tue, 24 May 2022 18:16:47 -0700 Subject: [PATCH 004/118] add runtimeType in model config --- .../org/pytorch/serve/util/ConfigManager.java | 28 +++++++++++++++++++ .../java/org/pytorch/serve/wlm/Model.java | 4 +-- .../org/pytorch/serve/wlm/ModelManager.java | 6 ++++ 3 files changed, 36 insertions(+), 2 deletions(-) diff --git a/frontend/server/src/main/java/org/pytorch/serve/util/ConfigManager.java b/frontend/server/src/main/java/org/pytorch/serve/util/ConfigManager.java index 7a11de5bbc..c9a2432bd6 100644 --- a/frontend/server/src/main/java/org/pytorch/serve/util/ConfigManager.java +++ b/frontend/server/src/main/java/org/pytorch/serve/util/ConfigManager.java @@ -43,6 +43,8 @@ import org.apache.commons.cli.Option; import org.apache.commons.cli.Options; import org.apache.commons.io.IOUtils; +import org.pytorch.serve.archive.model.Manifest; +import org.pytorch.serve.ensemble.WorkflowManifest; import org.pytorch.serve.servingsdk.snapshot.SnapshotSerializer; import org.pytorch.serve.snapshot.SnapshotSerializerFactory; import org.slf4j.LoggerFactory; @@ -826,6 +828,32 @@ public int getJsonIntValue(String modelName, String version, String element, int return value; } + public Manifest.RuntimeType getJsonRuntimeTypeValue(String modelName, + String version, + String element, + Manifest.RuntimeType defaultVal) { + Manifest.RuntimeType value = defaultVal; + if (this.modelConfig.containsKey(modelName)) { + Map versionModel = this.modelConfig.get(modelName); + JsonObject jsonObject = versionModel.getOrDefault(version, null); + + if (jsonObject != null && jsonObject.get(element) != null) { + try { + value = Manifest.RuntimeType.fromValue(jsonObject.get(element).getAsString()); + } catch (ClassCastException | IllegalStateException | IllegalArgumentException e) { + LoggerFactory.getLogger(ConfigManager.class) + .error( + "Invalid value for model: {}:{}, parameter: {}", + modelName, + version, + element); + return defaultVal; + } + } + } + return value; + } + public static final class Arguments { private String tsConfigFile; diff --git a/frontend/server/src/main/java/org/pytorch/serve/wlm/Model.java b/frontend/server/src/main/java/org/pytorch/serve/wlm/Model.java index 1c1545d344..0dfb9bd9bc 100644 --- a/frontend/server/src/main/java/org/pytorch/serve/wlm/Model.java +++ b/frontend/server/src/main/java/org/pytorch/serve/wlm/Model.java @@ -157,8 +157,8 @@ public Manifest.RuntimeType getRuntimeType() { return this.runtimeType; } - public void setRuntimeType(String runtimeType) { - this.runtimeType = Manifest.RuntimeType.fromValue(runtimeType); + public void setRuntimeType(Manifest.RuntimeType runtimeType) { + this.runtimeType = runtimeType; } public void addJob(String threadId, Job job) { diff --git a/frontend/server/src/main/java/org/pytorch/serve/wlm/ModelManager.java b/frontend/server/src/main/java/org/pytorch/serve/wlm/ModelManager.java index 7245241cab..715e4e7c85 100644 --- a/frontend/server/src/main/java/org/pytorch/serve/wlm/ModelManager.java +++ b/frontend/server/src/main/java/org/pytorch/serve/wlm/ModelManager.java @@ -285,6 +285,12 @@ private Model createModel( Model.RESPONSE_TIMEOUT, responseTimeout)); model.setWorkflowModel(isWorkflowModel); + model.setRuntimeType( + configManager.getJsonRuntimeTypeValue( + archive.getModelName(), + archive.getModelVersion(), + Model.RUNTIME_TYPE, + archive.getManifest().getRuntime())); return model; } From c01e8f849ff8f614c53f80582c02caed47359d81 Mon Sep 17 00:00:00 2001 From: lxning Date: Wed, 25 May 2022 19:34:33 -0700 Subject: [PATCH 005/118] add unit test --- .../org/pytorch/serve/util/ConfigManager.java | 1 - .../java/org/pytorch/serve/wlm/Model.java | 1 + .../pytorch/serve/wlm/WorkerLifeCycle.java | 15 ++++ .../serve/wlm/WorkerLifeCycleTest.java | 68 +++++++++++++++++++ .../test/resources/config_test_cpp.properties | 48 +++++++++++++ frontend/server/testng.xml | 1 + 6 files changed, 133 insertions(+), 1 deletion(-) create mode 100644 frontend/server/src/test/java/org/pytorch/serve/wlm/WorkerLifeCycleTest.java create mode 100644 frontend/server/src/test/resources/config_test_cpp.properties diff --git a/frontend/server/src/main/java/org/pytorch/serve/util/ConfigManager.java b/frontend/server/src/main/java/org/pytorch/serve/util/ConfigManager.java index c9a2432bd6..6b027a7c66 100644 --- a/frontend/server/src/main/java/org/pytorch/serve/util/ConfigManager.java +++ b/frontend/server/src/main/java/org/pytorch/serve/util/ConfigManager.java @@ -44,7 +44,6 @@ import org.apache.commons.cli.Options; import org.apache.commons.io.IOUtils; import org.pytorch.serve.archive.model.Manifest; -import org.pytorch.serve.ensemble.WorkflowManifest; import org.pytorch.serve.servingsdk.snapshot.SnapshotSerializer; import org.pytorch.serve.snapshot.SnapshotSerializerFactory; import org.slf4j.LoggerFactory; diff --git a/frontend/server/src/main/java/org/pytorch/serve/wlm/Model.java b/frontend/server/src/main/java/org/pytorch/serve/wlm/Model.java index 0dfb9bd9bc..47ed7f97c2 100644 --- a/frontend/server/src/main/java/org/pytorch/serve/wlm/Model.java +++ b/frontend/server/src/main/java/org/pytorch/serve/wlm/Model.java @@ -63,6 +63,7 @@ public Model(ModelArchive modelArchive, int queueSize) { modelVersionName = new ModelVersionName( this.modelArchive.getModelName(), this.modelArchive.getModelVersion()); + runtimeType = modelArchive.getManifest().getRuntime(); } public JsonObject getModelState(boolean isDefaultVersion) { diff --git a/frontend/server/src/main/java/org/pytorch/serve/wlm/WorkerLifeCycle.java b/frontend/server/src/main/java/org/pytorch/serve/wlm/WorkerLifeCycle.java index ac06cd0049..0e60213878 100644 --- a/frontend/server/src/main/java/org/pytorch/serve/wlm/WorkerLifeCycle.java +++ b/frontend/server/src/main/java/org/pytorch/serve/wlm/WorkerLifeCycle.java @@ -9,6 +9,7 @@ import java.util.concurrent.CountDownLatch; import java.util.concurrent.TimeUnit; import java.util.concurrent.atomic.AtomicBoolean; + import org.pytorch.serve.metrics.Metric; import org.pytorch.serve.util.ConfigManager; import org.pytorch.serve.util.Connector; @@ -81,6 +82,20 @@ public boolean isLauncherAvailable() } public void startWorker(int port) throws WorkerInitializationException, InterruptedException { + switch (model.getRuntimeType()) { + case LSP: + logger.info("LSP startWorker"); + break; + case LDP: + logger.info("LDP startWorker"); + break; + default: + startWorkerPython(port); + break; + } + } + + private void startWorkerPython(int port) throws WorkerInitializationException, InterruptedException { File workingDir = new File(configManager.getModelServerHome()); File modelPath; setPort(port); diff --git a/frontend/server/src/test/java/org/pytorch/serve/wlm/WorkerLifeCycleTest.java b/frontend/server/src/test/java/org/pytorch/serve/wlm/WorkerLifeCycleTest.java new file mode 100644 index 0000000000..f5e298caf1 --- /dev/null +++ b/frontend/server/src/test/java/org/pytorch/serve/wlm/WorkerLifeCycleTest.java @@ -0,0 +1,68 @@ +package org.pytorch.serve.wlm; + +import org.apache.commons.io.FileUtils; +import org.pytorch.serve.archive.DownloadArchiveException; +import org.pytorch.serve.archive.model.Manifest; +import org.pytorch.serve.archive.model.ModelArchive; +import org.pytorch.serve.archive.model.ModelException; +import org.pytorch.serve.util.ConfigManager; +import org.testng.Assert; +import org.testng.annotations.BeforeSuite; +import org.testng.annotations.Test; + +import java.io.File; +import java.io.IOException; +import java.util.Collections; +import java.util.List; + +import static org.pytorch.serve.archive.model.Manifest.RuntimeType.LSP; + +public class WorkerLifeCycleTest { + private static final List ALLOWED_URLS_LIST = + Collections.singletonList("file://.*|http(s)?://.*"); + private ConfigManager configManager; + + @BeforeSuite + public void beforeSuite() throws IOException { + System.setProperty("tsConfigFile", "src/test/resources/config_test_cpp.properties"); + ConfigManager.Arguments args = new ConfigManager.Arguments(); + //args.setModels(new String[] {"noop_v0.1"}); + args.setSnapshotDisabled(true); + ConfigManager.init(args); + configManager = ConfigManager.getInstance(); + } + + @Test + public void testStartWorkerNoop() throws + ModelException, + IOException, + DownloadArchiveException { + ModelArchive archiveNoop = + ModelArchive.downloadModel(ALLOWED_URLS_LIST, configManager.getModelStore(), "noop.mar"); + Model modelNoop = new Model(archiveNoop, 100); + Assert.assertEquals(modelNoop.getRuntimeType().getValue(), "python"); + } + + @Test + public void testStartWorkerMnist() throws + ModelException, + IOException, + DownloadArchiveException, + WorkerInitializationException, + InterruptedException { + ModelArchive archiveMnist = + ModelArchive.downloadModel(ALLOWED_URLS_LIST, configManager.getModelStore(), "mnist_scripted.mar"); + Model modelMnist = new Model(archiveMnist, 100); + Assert.assertEquals(archiveMnist.getModelName(), "mnist_ts"); + Assert.assertEquals(archiveMnist.getModelVersion(), "1.0"); + modelMnist.setRuntimeType( + configManager.getJsonRuntimeTypeValue( + archiveMnist.getModelName(), + archiveMnist.getModelVersion(), + Model.RUNTIME_TYPE, + archiveMnist.getManifest().getRuntime())); + Assert.assertEquals(modelMnist.getRuntimeType().getValue(), LSP.getValue()); + WorkerLifeCycle workerLifeCycleMnist = new WorkerLifeCycle(configManager, modelMnist); + workerLifeCycleMnist.startWorker(configManager.getInitialWorkerPort()); + } +} diff --git a/frontend/server/src/test/resources/config_test_cpp.properties b/frontend/server/src/test/resources/config_test_cpp.properties new file mode 100644 index 0000000000..e0b475ccf8 --- /dev/null +++ b/frontend/server/src/test/resources/config_test_cpp.properties @@ -0,0 +1,48 @@ +load_models=noop +# number_of_netty_threads=0 +# netty_client_threads=0 +# default_workers_per_model=0 +# job_queue_size=100 +async_logging=true +default_response_timeout=120 +unregister_model_timeout=120 +# number_of_gpu=1 +# cors_allowed_origin +# cors_allowed_methods +# cors_allowed_headers +# keystore=src/test/resources/keystore.p12 +# keystore_pass=changeit +# keystore_type=PKCS12 +private_key_file=src/test/resources/key.pem +certificate_file=src/test/resources/certs.pem +# max_response_size=6553500 +max_request_size=10485760 +# blacklist_env_vars=.*USERNAME.*|.*PASSWORD.* +# enable_envvars_config=false +# decode_input_request=true +model_store=../archive/src/test/resources/models +models={\ + "noop": {\ + "1.0": {\ + "defaultVersion": true,\ + "marName": "noop.mar",\ + "minWorkers": 1,\ + "maxWorkers": 1,\ + "batchSize": 4,\ + "maxBatchDelay": 100,\ + "responseTimeout": 120\ + }\ + },\ + "mnist_ts": {\ + "1.0": {\ + "defaultVersion": true,\ + "marName": "mnist_scripted.mar",\ + "minWorkers": 1,\ + "maxWorkers": 4,\ + "batchSize": 8,\ + "maxBatchDelay": 100,\ + "responseTimeout": 120,\ + "runtimeType": "libtorch_scripted_process"\ + }\ + }\ +} diff --git a/frontend/server/testng.xml b/frontend/server/testng.xml index de8a0d574c..7442b84229 100644 --- a/frontend/server/testng.xml +++ b/frontend/server/testng.xml @@ -3,6 +3,7 @@ + From 246ca019dc67b414d807120de156180e851b1055 Mon Sep 17 00:00:00 2001 From: lxning Date: Wed, 25 May 2022 20:11:23 -0700 Subject: [PATCH 006/118] revert test/buildspec_gpu.yml --- test/buildspec_gpu.yml | 4 ---- 1 file changed, 4 deletions(-) diff --git a/test/buildspec_gpu.yml b/test/buildspec_gpu.yml index 2cd31f84de..300c560fa9 100644 --- a/test/buildspec_gpu.yml +++ b/test/buildspec_gpu.yml @@ -7,10 +7,6 @@ phases: runtime-versions: python: 3.8 commands: - # Workaround from https://github.com/NVIDIA/nvidia-docker/issues/1632 - - apt-key del 7fa2af80 - - apt-key adv --fetch-keys https://developer.download.nvidia.com/compute/cuda/repos/ubuntu2004/x86_64/3bf863cc.pub - - apt-key adv --fetch-keys https://developer.download.nvidia.com/compute/machine-learning/repos/ubuntu2004/x86_64/7fa2af80.pub - apt-get update - apt-get install sudo -y - curl -O https://bootstrap.pypa.io/get-pip.py && python get-pip.py From ea6845fe2d47fe94dc59387dc68de0617e4cefd9 Mon Sep 17 00:00:00 2001 From: lxning Date: Wed, 25 May 2022 21:22:59 -0700 Subject: [PATCH 007/118] update testng.xml --- frontend/server/testng.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/frontend/server/testng.xml b/frontend/server/testng.xml index 7442b84229..76414771c9 100644 --- a/frontend/server/testng.xml +++ b/frontend/server/testng.xml @@ -3,13 +3,13 @@ - + From 101c6378fdba109edb90dde5b87ff54f0594d96b Mon Sep 17 00:00:00 2001 From: lxning Date: Wed, 25 May 2022 22:45:02 -0700 Subject: [PATCH 008/118] update json files --- .../src/main/java/org/pytorch/serve/util/ConfigManager.java | 6 ++---- frontend/server/src/test/resources/management_open_api.json | 4 +++- frontend/server/src/test/resources/snapshots/snapshot1.cfg | 2 +- frontend/server/src/test/resources/snapshots/snapshot3.cfg | 2 +- frontend/server/src/test/resources/snapshots/snapshot4.cfg | 2 +- frontend/server/src/test/resources/snapshots/snapshot5.cfg | 2 +- frontend/server/src/test/resources/snapshots/snapshot6.cfg | 2 +- frontend/server/src/test/resources/snapshots/snapshot7.cfg | 2 +- frontend/server/src/test/resources/snapshots/snapshot8.cfg | 2 +- frontend/server/src/test/resources/snapshots/snapshot9.cfg | 2 +- 10 files changed, 13 insertions(+), 13 deletions(-) diff --git a/frontend/server/src/main/java/org/pytorch/serve/util/ConfigManager.java b/frontend/server/src/main/java/org/pytorch/serve/util/ConfigManager.java index 6b027a7c66..019c70b0b0 100644 --- a/frontend/server/src/main/java/org/pytorch/serve/util/ConfigManager.java +++ b/frontend/server/src/main/java/org/pytorch/serve/util/ConfigManager.java @@ -827,10 +827,8 @@ public int getJsonIntValue(String modelName, String version, String element, int return value; } - public Manifest.RuntimeType getJsonRuntimeTypeValue(String modelName, - String version, - String element, - Manifest.RuntimeType defaultVal) { + public Manifest.RuntimeType getJsonRuntimeTypeValue( + String modelName, String version, String element, Manifest.RuntimeType defaultVal) { Manifest.RuntimeType value = defaultVal; if (this.modelConfig.containsKey(modelName)) { Map versionModel = this.modelConfig.get(modelName); diff --git a/frontend/server/src/test/resources/management_open_api.json b/frontend/server/src/test/resources/management_open_api.json index 3f9e0a70c0..bc76840bad 100644 --- a/frontend/server/src/test/resources/management_open_api.json +++ b/frontend/server/src/test/resources/management_open_api.json @@ -208,7 +208,9 @@ "enum": [ "PYTHON", "PYTHON2", - "PYTHON3" + "PYTHON3", + "LSP", + "LDP" ] } }, diff --git a/frontend/server/src/test/resources/snapshots/snapshot1.cfg b/frontend/server/src/test/resources/snapshots/snapshot1.cfg index a368434610..1f8178f1ae 100644 --- a/frontend/server/src/test/resources/snapshots/snapshot1.cfg +++ b/frontend/server/src/test/resources/snapshots/snapshot1.cfg @@ -9,7 +9,7 @@ default_workers_per_model=4 model_store=../archive/src/test/resources/models async_logging=true number_of_gpu=0 -model_snapshot={\n "name"\: "20200329045334828-startup.cfg",\n "modelCount"\: 1,\n "created"\: 1585457614832,\n "models"\: {\n "noop"\: {\n "1.11"\: {\n "defaultVersion"\: true,\n "marName"\: "noop.mar",\n "minWorkers"\: 4,\n "maxWorkers"\: 4,\n "batchSize"\: 1,\n "maxBatchDelay"\: 100,\n "responseTimeout"\: 120\n }\n }\n }\n} +model_snapshot={\n "name"\: "20200329045334828-startup.cfg",\n "modelCount"\: 1,\n "created"\: 1585457614832,\n "models"\: {\n "noop"\: {\n "1.11"\: {\n "defaultVersion"\: true,\n "marName"\: "noop.mar",\n "minWorkers"\: 4,\n "maxWorkers"\: 4,\n "batchSize"\: 1,\n "maxBatchDelay"\: 100,\n "responseTimeout"\: 120,\n "runtimeType"\: "python"\n }\n }\n }\n} tsConfigFile=src/test/resources/config.properties max_response_size=2047093252 max_request_size=2047093252 diff --git a/frontend/server/src/test/resources/snapshots/snapshot3.cfg b/frontend/server/src/test/resources/snapshots/snapshot3.cfg index 37431cabc0..1f6e88ae99 100644 --- a/frontend/server/src/test/resources/snapshots/snapshot3.cfg +++ b/frontend/server/src/test/resources/snapshots/snapshot3.cfg @@ -9,7 +9,7 @@ default_workers_per_model=4 model_store=../archive/src/test/resources/models async_logging=true number_of_gpu=0 -model_snapshot={\n "name"\: "20200329045335910-snapshot.cfg",\n "modelCount"\: 1,\n "created"\: 1585457615910,\n "models"\: {\n "noop_v1.0"\: {\n "1.11"\: {\n "defaultVersion"\: true,\n "marName"\: "noop.mar",\n "minWorkers"\: 0,\n "maxWorkers"\: 0,\n "batchSize"\: 1,\n "maxBatchDelay"\: 100,\n "responseTimeout"\: 120\n }\n }\n }\n} +model_snapshot={\n "name"\: "20200329045335910-snapshot.cfg",\n "modelCount"\: 1,\n "created"\: 1585457615910,\n "models"\: {\n "noop_v1.0"\: {\n "1.11"\: {\n "defaultVersion"\: true,\n "marName"\: "noop.mar",\n "minWorkers"\: 0,\n "maxWorkers"\: 0,\n "batchSize"\: 1,\n "maxBatchDelay"\: 100,\n "responseTimeout"\: 120,\n "runtimeType"\: "python"\n }\n }\n }\n} tsConfigFile=src/test/resources/config.properties max_response_size=2047093252 max_request_size=2047093252 diff --git a/frontend/server/src/test/resources/snapshots/snapshot4.cfg b/frontend/server/src/test/resources/snapshots/snapshot4.cfg index cd0d5ff59a..075e0aad9e 100644 --- a/frontend/server/src/test/resources/snapshots/snapshot4.cfg +++ b/frontend/server/src/test/resources/snapshots/snapshot4.cfg @@ -9,7 +9,7 @@ default_workers_per_model=4 model_store=../archive/src/test/resources/models async_logging=true number_of_gpu=0 -model_snapshot={\n "name"\: "20200329065301226-snapshot.cfg",\n "modelCount"\: 1,\n "created"\: 1585464781226,\n "models"\: {\n "noop_v1.0"\: {\n "1.11"\: {\n "defaultVersion"\: true,\n "marName"\: "noop.mar",\n "minWorkers"\: 1,\n "maxWorkers"\: 1,\n "batchSize"\: 1,\n "maxBatchDelay"\: 100,\n "responseTimeout"\: 120\n }\n }\n }\n} +model_snapshot={\n "name"\: "20200329065301226-snapshot.cfg",\n "modelCount"\: 1,\n "created"\: 1585464781226,\n "models"\: {\n "noop_v1.0"\: {\n "1.11"\: {\n "defaultVersion"\: true,\n "marName"\: "noop.mar",\n "minWorkers"\: 1,\n "maxWorkers"\: 1,\n "batchSize"\: 1,\n "maxBatchDelay"\: 100,\n "responseTimeout"\: 120,\n "runtimeType"\: "python"\n }\n }\n }\n} tsConfigFile=src/test/resources/config.properties max_response_size=2047093252 max_request_size=2047093252 diff --git a/frontend/server/src/test/resources/snapshots/snapshot5.cfg b/frontend/server/src/test/resources/snapshots/snapshot5.cfg index f44a89fe92..2e00f5ea6d 100644 --- a/frontend/server/src/test/resources/snapshots/snapshot5.cfg +++ b/frontend/server/src/test/resources/snapshots/snapshot5.cfg @@ -9,7 +9,7 @@ default_workers_per_model=4 model_store=../archive/src/test/resources/models async_logging=true number_of_gpu=0 -model_snapshot={\n "name"\: "20200329072056820-snapshot.cfg",\n "modelCount"\: 2,\n "created"\: 1585466456820,\n "models"\: {\n "noop"\: {\n "1.11"\: {\n "defaultVersion"\: true,\n "marName"\: "noop.mar",\n "minWorkers"\: 1,\n "maxWorkers"\: 1,\n "batchSize"\: 1,\n "maxBatchDelay"\: 100,\n "responseTimeout"\: 120\n }\n },\n "noop_v1.0"\: {\n "1.11"\: {\n "defaultVersion"\: true,\n "marName"\: "noop.mar",\n "minWorkers"\: 1,\n "maxWorkers"\: 1,\n "batchSize"\: 1,\n "maxBatchDelay"\: 100,\n "responseTimeout"\: 120\n }\n }\n }\n} +model_snapshot={\n "name"\: "20200329072056820-snapshot.cfg",\n "modelCount"\: 2,\n "created"\: 1585466456820,\n "models"\: {\n "noop"\: {\n "1.11"\: {\n "defaultVersion"\: true,\n "marName"\: "noop.mar",\n "minWorkers"\: 1,\n "maxWorkers"\: 1,\n "batchSize"\: 1,\n "maxBatchDelay"\: 100,\n "responseTimeout"\: 120,\n "runtimeType"\: "python"\n }\n },\n "noop_v1.0"\: {\n "1.11"\: {\n "defaultVersion"\: true,\n "marName"\: "noop.mar",\n "minWorkers"\: 1,\n "maxWorkers"\: 1,\n "batchSize"\: 1,\n "maxBatchDelay"\: 100,\n "responseTimeout"\: 120,\n "runtimeType"\: "python"\n }\n }\n }\n} tsConfigFile=src/test/resources/config.properties max_response_size=2047093252 max_request_size=2047093252 diff --git a/frontend/server/src/test/resources/snapshots/snapshot6.cfg b/frontend/server/src/test/resources/snapshots/snapshot6.cfg index a177a74741..374c90ba81 100644 --- a/frontend/server/src/test/resources/snapshots/snapshot6.cfg +++ b/frontend/server/src/test/resources/snapshots/snapshot6.cfg @@ -9,7 +9,7 @@ default_workers_per_model=4 model_store=../archive/src/test/resources/models async_logging=true number_of_gpu=0 -model_snapshot={\n "name"\: "20200329072056831-snapshot.cfg",\n "modelCount"\: 3,\n "created"\: 1585466456831,\n "models"\: {\n "noop"\: {\n "1.11"\: {\n "defaultVersion"\: true,\n "marName"\: "noop.mar",\n "minWorkers"\: 1,\n "maxWorkers"\: 1,\n "batchSize"\: 1,\n "maxBatchDelay"\: 100,\n "responseTimeout"\: 120\n }\n },\n "noop_v1.0"\: {\n "1.11"\: {\n "defaultVersion"\: true,\n "marName"\: "noop.mar",\n "minWorkers"\: 1,\n "maxWorkers"\: 1,\n "batchSize"\: 1,\n "maxBatchDelay"\: 100,\n "responseTimeout"\: 120\n }\n },\n "noopversioned"\: {\n "1.11"\: {\n "defaultVersion"\: true,\n "marName"\: "noop.mar",\n "minWorkers"\: 1,\n "maxWorkers"\: 1,\n "batchSize"\: 1,\n "maxBatchDelay"\: 100,\n "responseTimeout"\: 120\n }\n }\n }\n} +model_snapshot={\n "name"\: "20200329072056831-snapshot.cfg",\n "modelCount"\: 3,\n "created"\: 1585466456831,\n "models"\: {\n "noop"\: {\n "1.11"\: {\n "defaultVersion"\: true,\n "marName"\: "noop.mar",\n "minWorkers"\: 1,\n "maxWorkers"\: 1,\n "batchSize"\: 1,\n "maxBatchDelay"\: 100,\n "responseTimeout"\: 120,\n "runtimeType"\: "python"\n }\n },\n "noop_v1.0"\: {\n "1.11"\: {\n "defaultVersion"\: true,\n "marName"\: "noop.mar",\n "minWorkers"\: 1,\n "maxWorkers"\: 1,\n "batchSize"\: 1,\n "maxBatchDelay"\: 100,\n "responseTimeout"\: 120,\n "runtimeType"\: "python"\n }\n },\n "noopversioned"\: {\n "1.11"\: {\n "defaultVersion"\: true,\n "marName"\: "noop.mar",\n "minWorkers"\: 1,\n "maxWorkers"\: 1,\n "batchSize"\: 1,\n "maxBatchDelay"\: 100,\n "responseTimeout"\: 120,\n "runtimeType"\: "python"\n }\n }\n }\n} tsConfigFile=src/test/resources/config.properties max_response_size=2047093252 max_request_size=2047093252 diff --git a/frontend/server/src/test/resources/snapshots/snapshot7.cfg b/frontend/server/src/test/resources/snapshots/snapshot7.cfg index 1a51fcfa66..392ec89fad 100644 --- a/frontend/server/src/test/resources/snapshots/snapshot7.cfg +++ b/frontend/server/src/test/resources/snapshots/snapshot7.cfg @@ -9,7 +9,7 @@ default_workers_per_model=4 model_store=../archive/src/test/resources/models async_logging=true number_of_gpu=0 -model_snapshot={\n "name"\: "20200329072056839-snapshot.cfg",\n "modelCount"\: 4,\n "created"\: 1585466456840,\n "models"\: {\n "noop"\: {\n "1.11"\: {\n "defaultVersion"\: true,\n "marName"\: "noop.mar",\n "minWorkers"\: 1,\n "maxWorkers"\: 1,\n "batchSize"\: 1,\n "maxBatchDelay"\: 100,\n "responseTimeout"\: 120\n }\n },\n "noop_v1.0"\: {\n "1.11"\: {\n "defaultVersion"\: true,\n "marName"\: "noop.mar",\n "minWorkers"\: 1,\n "maxWorkers"\: 1,\n "batchSize"\: 1,\n "maxBatchDelay"\: 100,\n "responseTimeout"\: 120\n }\n },\n "noopversioned"\: {\n "1.2.1"\: {\n "defaultVersion"\: false,\n "marName"\: "noop_v2.mar",\n "minWorkers"\: 1,\n "maxWorkers"\: 1,\n "batchSize"\: 1,\n "maxBatchDelay"\: 100,\n "responseTimeout"\: 120\n },\n "1.11"\: {\n "defaultVersion"\: true,\n "marName"\: "noop.mar",\n "minWorkers"\: 1,\n "maxWorkers"\: 1,\n "batchSize"\: 1,\n "maxBatchDelay"\: 100,\n "responseTimeout"\: 120\n }\n }\n }\n} +model_snapshot={\n "name"\: "20200329072056839-snapshot.cfg",\n "modelCount"\: 4,\n "created"\: 1585466456840,\n "models"\: {\n "noop"\: {\n "1.11"\: {\n "defaultVersion"\: true,\n "marName"\: "noop.mar",\n "minWorkers"\: 1,\n "maxWorkers"\: 1,\n "batchSize"\: 1,\n "maxBatchDelay"\: 100,\n "responseTimeout"\: 120,\n "runtimeType"\: "python"\n }\n },\n "noop_v1.0"\: {\n "1.11"\: {\n "defaultVersion"\: true,\n "marName"\: "noop.mar",\n "minWorkers"\: 1,\n "maxWorkers"\: 1,\n "batchSize"\: 1,\n "maxBatchDelay"\: 100,\n "responseTimeout"\: 120,\n "runtimeType"\: "python"\n }\n },\n "noopversioned"\: {\n "1.2.1"\: {\n "defaultVersion"\: false,\n "marName"\: "noop_v2.mar",\n "minWorkers"\: 1,\n "maxWorkers"\: 1,\n "batchSize"\: 1,\n "maxBatchDelay"\: 100,\n "responseTimeout"\: 120,\n "runtimeType"\: "python"\n },\n "1.11"\: {\n "defaultVersion"\: true,\n "marName"\: "noop.mar",\n "minWorkers"\: 1,\n "maxWorkers"\: 1,\n "batchSize"\: 1,\n "maxBatchDelay"\: 100,\n "responseTimeout"\: 120,\n "runtimeType"\: "python"\n }\n }\n }\n} tsConfigFile=src/test/resources/config.properties max_response_size=2047093252 max_request_size=2047093252 diff --git a/frontend/server/src/test/resources/snapshots/snapshot8.cfg b/frontend/server/src/test/resources/snapshots/snapshot8.cfg index ebd925b596..ba4ce685bc 100644 --- a/frontend/server/src/test/resources/snapshots/snapshot8.cfg +++ b/frontend/server/src/test/resources/snapshots/snapshot8.cfg @@ -9,7 +9,7 @@ default_workers_per_model=4 model_store=../archive/src/test/resources/models async_logging=true number_of_gpu=0 -model_snapshot={\n "name"\: "20200329072459543-snapshot.cfg",\n "modelCount"\: 4,\n "created"\: 1585466699543,\n "models"\: {\n "noop"\: {\n "1.11"\: {\n "defaultVersion"\: true,\n "marName"\: "noop.mar",\n "minWorkers"\: 1,\n "maxWorkers"\: 1,\n "batchSize"\: 1,\n "maxBatchDelay"\: 100,\n "responseTimeout"\: 120\n }\n },\n "noop_v1.0"\: {\n "1.11"\: {\n "defaultVersion"\: true,\n "marName"\: "noop.mar",\n "minWorkers"\: 1,\n "maxWorkers"\: 1,\n "batchSize"\: 1,\n "maxBatchDelay"\: 100,\n "responseTimeout"\: 120\n }\n },\n "noopversioned"\: {\n "1.2.1"\: {\n "defaultVersion"\: true,\n "marName"\: "noop_v2.mar",\n "minWorkers"\: 1,\n "maxWorkers"\: 1,\n "batchSize"\: 1,\n "maxBatchDelay"\: 100,\n "responseTimeout"\: 120\n },\n "1.11"\: {\n "defaultVersion"\: false,\n "marName"\: "noop.mar",\n "minWorkers"\: 1,\n "maxWorkers"\: 1,\n "batchSize"\: 1,\n "maxBatchDelay"\: 100,\n "responseTimeout"\: 120\n }\n }\n }\n} +model_snapshot={\n "name"\: "20200329072459543-snapshot.cfg",\n "modelCount"\: 4,\n "created"\: 1585466699543,\n "models"\: {\n "noop"\: {\n "1.11"\: {\n "defaultVersion"\: true,\n "marName"\: "noop.mar",\n "minWorkers"\: 1,\n "maxWorkers"\: 1,\n "batchSize"\: 1,\n "maxBatchDelay"\: 100,\n "responseTimeout"\: 120,\n "runtimeType"\: "python"\n }\n },\n "noop_v1.0"\: {\n "1.11"\: {\n "defaultVersion"\: true,\n "marName"\: "noop.mar",\n "minWorkers"\: 1,\n "maxWorkers"\: 1,\n "batchSize"\: 1,\n "maxBatchDelay"\: 100,\n "responseTimeout"\: 120,\n "runtimeType"\: "python"\n }\n },\n "noopversioned"\: {\n "1.2.1"\: {\n "defaultVersion"\: true,\n "marName"\: "noop_v2.mar",\n "minWorkers"\: 1,\n "maxWorkers"\: 1,\n "batchSize"\: 1,\n "maxBatchDelay"\: 100,\n "responseTimeout"\: 120,\n "runtimeType"\: "python"\n },\n "1.11"\: {\n "defaultVersion"\: false,\n "marName"\: "noop.mar",\n "minWorkers"\: 1,\n "maxWorkers"\: 1,\n "batchSize"\: 1,\n "maxBatchDelay"\: 100,\n "responseTimeout"\: 120,\n "runtimeType"\: "python"\n }\n }\n }\n} tsConfigFile=src/test/resources/config.properties max_response_size=2047093252 max_request_size=2047093252 diff --git a/frontend/server/src/test/resources/snapshots/snapshot9.cfg b/frontend/server/src/test/resources/snapshots/snapshot9.cfg index 9505364d28..9ef2db76fc 100644 --- a/frontend/server/src/test/resources/snapshots/snapshot9.cfg +++ b/frontend/server/src/test/resources/snapshots/snapshot9.cfg @@ -9,7 +9,7 @@ default_workers_per_model=4 model_store=../archive/src/test/resources/models async_logging=true number_of_gpu=0 -model_snapshot={\n "name"\: "20200331062429525-snapshot.cfg",\n "modelCount"\: 4,\n "created"\: 1585635869526,\n "models"\: {\n "noop"\: {\n "1.11"\: {\n "defaultVersion"\: true,\n "marName"\: "noop.mar",\n "minWorkers"\: 1,\n "maxWorkers"\: 1,\n "batchSize"\: 1,\n "maxBatchDelay"\: 100,\n "responseTimeout"\: 120\n }\n },\n "noop_v1.0"\: {\n "1.11"\: {\n "defaultVersion"\: true,\n "marName"\: "noop.mar",\n "minWorkers"\: 2,\n "maxWorkers"\: 2,\n "batchSize"\: 1,\n "maxBatchDelay"\: 100,\n "responseTimeout"\: 120\n }\n },\n "noopversioned"\: {\n "1.2.1"\: {\n "defaultVersion"\: true,\n "marName"\: "noop_v2.mar",\n "minWorkers"\: 1,\n "maxWorkers"\: 1,\n "batchSize"\: 1,\n "maxBatchDelay"\: 100,\n "responseTimeout"\: 120\n },\n "1.11"\: {\n "defaultVersion"\: false,\n "marName"\: "noop.mar",\n "minWorkers"\: 1,\n "maxWorkers"\: 1,\n "batchSize"\: 1,\n "maxBatchDelay"\: 100,\n "responseTimeout"\: 120\n }\n }\n }\n} +model_snapshot={\n "name"\: "20200331062429525-snapshot.cfg",\n "modelCount"\: 4,\n "created"\: 1585635869526,\n "models"\: {\n "noop"\: {\n "1.11"\: {\n "defaultVersion"\: true,\n "marName"\: "noop.mar",\n "minWorkers"\: 1,\n "maxWorkers"\: 1,\n "batchSize"\: 1,\n "maxBatchDelay"\: 100,\n "responseTimeout"\: 120,\n "runtimeType"\: "python"\n }\n },\n "noop_v1.0"\: {\n "1.11"\: {\n "defaultVersion"\: true,\n "marName"\: "noop.mar",\n "minWorkers"\: 2,\n "maxWorkers"\: 2,\n "batchSize"\: 1,\n "maxBatchDelay"\: 100,\n "responseTimeout"\: 120,\n "runtimeType"\: "python"\n }\n },\n "noopversioned"\: {\n "1.2.1"\: {\n "defaultVersion"\: true,\n "marName"\: "noop_v2.mar",\n "minWorkers"\: 1,\n "maxWorkers"\: 1,\n "batchSize"\: 1,\n "maxBatchDelay"\: 100,\n "responseTimeout"\: 120,\n "runtimeType"\: "python"\n },\n "1.11"\: {\n "defaultVersion"\: false,\n "marName"\: "noop.mar",\n "minWorkers"\: 1,\n "maxWorkers"\: 1,\n "batchSize"\: 1,\n "maxBatchDelay"\: 100,\n "responseTimeout"\: 120,\n "runtimeType"\: "python"\n }\n }\n }\n} tsConfigFile=src/test/resources/config.properties max_response_size=2047093252 max_request_size=2047093252 From 7345664c667ae8cddc3e426e798573669ed737ef Mon Sep 17 00:00:00 2001 From: lxning Date: Wed, 25 May 2022 22:52:50 -0700 Subject: [PATCH 009/118] fmt --- .../src/main/java/org/pytorch/serve/wlm/WorkerLifeCycle.java | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/frontend/server/src/main/java/org/pytorch/serve/wlm/WorkerLifeCycle.java b/frontend/server/src/main/java/org/pytorch/serve/wlm/WorkerLifeCycle.java index 0e60213878..7d9abb2877 100644 --- a/frontend/server/src/main/java/org/pytorch/serve/wlm/WorkerLifeCycle.java +++ b/frontend/server/src/main/java/org/pytorch/serve/wlm/WorkerLifeCycle.java @@ -9,7 +9,6 @@ import java.util.concurrent.CountDownLatch; import java.util.concurrent.TimeUnit; import java.util.concurrent.atomic.AtomicBoolean; - import org.pytorch.serve.metrics.Metric; import org.pytorch.serve.util.ConfigManager; import org.pytorch.serve.util.Connector; @@ -95,7 +94,8 @@ public void startWorker(int port) throws WorkerInitializationException, Interrup } } - private void startWorkerPython(int port) throws WorkerInitializationException, InterruptedException { + private void startWorkerPython(int port) + throws WorkerInitializationException, InterruptedException { File workingDir = new File(configManager.getModelServerHome()); File modelPath; setPort(port); From 42ecd084ddebeba44189e2d7e2d0279ad681e029 Mon Sep 17 00:00:00 2001 From: lxning Date: Wed, 25 May 2022 23:05:34 -0700 Subject: [PATCH 010/118] fmt --- .../serve/wlm/WorkerLifeCycleTest.java | 36 ++++++++----------- 1 file changed, 14 insertions(+), 22 deletions(-) diff --git a/frontend/server/src/test/java/org/pytorch/serve/wlm/WorkerLifeCycleTest.java b/frontend/server/src/test/java/org/pytorch/serve/wlm/WorkerLifeCycleTest.java index f5e298caf1..19a3864a6e 100644 --- a/frontend/server/src/test/java/org/pytorch/serve/wlm/WorkerLifeCycleTest.java +++ b/frontend/server/src/test/java/org/pytorch/serve/wlm/WorkerLifeCycleTest.java @@ -1,8 +1,11 @@ package org.pytorch.serve.wlm; -import org.apache.commons.io.FileUtils; +import static org.pytorch.serve.archive.model.Manifest.RuntimeType.LSP; + +import java.io.IOException; +import java.util.Collections; +import java.util.List; import org.pytorch.serve.archive.DownloadArchiveException; -import org.pytorch.serve.archive.model.Manifest; import org.pytorch.serve.archive.model.ModelArchive; import org.pytorch.serve.archive.model.ModelException; import org.pytorch.serve.util.ConfigManager; @@ -10,13 +13,6 @@ import org.testng.annotations.BeforeSuite; import org.testng.annotations.Test; -import java.io.File; -import java.io.IOException; -import java.util.Collections; -import java.util.List; - -import static org.pytorch.serve.archive.model.Manifest.RuntimeType.LSP; - public class WorkerLifeCycleTest { private static final List ALLOWED_URLS_LIST = Collections.singletonList("file://.*|http(s)?://.*"); @@ -26,32 +22,28 @@ public class WorkerLifeCycleTest { public void beforeSuite() throws IOException { System.setProperty("tsConfigFile", "src/test/resources/config_test_cpp.properties"); ConfigManager.Arguments args = new ConfigManager.Arguments(); - //args.setModels(new String[] {"noop_v0.1"}); + // args.setModels(new String[] {"noop_v0.1"}); args.setSnapshotDisabled(true); ConfigManager.init(args); configManager = ConfigManager.getInstance(); } @Test - public void testStartWorkerNoop() throws - ModelException, - IOException, - DownloadArchiveException { + public void testStartWorkerNoop() throws ModelException, IOException, DownloadArchiveException { ModelArchive archiveNoop = - ModelArchive.downloadModel(ALLOWED_URLS_LIST, configManager.getModelStore(), "noop.mar"); + ModelArchive.downloadModel( + ALLOWED_URLS_LIST, configManager.getModelStore(), "noop.mar"); Model modelNoop = new Model(archiveNoop, 100); Assert.assertEquals(modelNoop.getRuntimeType().getValue(), "python"); } @Test - public void testStartWorkerMnist() throws - ModelException, - IOException, - DownloadArchiveException, - WorkerInitializationException, - InterruptedException { + public void testStartWorkerMnist() + throws ModelException, IOException, DownloadArchiveException, + WorkerInitializationException, InterruptedException { ModelArchive archiveMnist = - ModelArchive.downloadModel(ALLOWED_URLS_LIST, configManager.getModelStore(), "mnist_scripted.mar"); + ModelArchive.downloadModel( + ALLOWED_URLS_LIST, configManager.getModelStore(), "mnist_scripted.mar"); Model modelMnist = new Model(archiveMnist, 100); Assert.assertEquals(archiveMnist.getModelName(), "mnist_ts"); Assert.assertEquals(archiveMnist.getModelVersion(), "1.0"); From a50c396d4eb931176895ce2c258b2c46c1cc0ef2 Mon Sep 17 00:00:00 2001 From: lxning Date: Tue, 7 Jun 2022 08:31:15 -0700 Subject: [PATCH 011/118] init cpp dir --- cpp/src/CMakeLists.txt | 32 ++++++++++++++++++++++++++++++++ cpp/src/backend/ts_backend.hh | 30 ++++++++++++++++++++++++++++++ cpp/src/util/runtime_type.hh | 31 +++++++++++++++++++++++++++++++ 3 files changed, 93 insertions(+) create mode 100644 cpp/src/CMakeLists.txt create mode 100644 cpp/src/backend/ts_backend.hh create mode 100644 cpp/src/util/runtime_type.hh diff --git a/cpp/src/CMakeLists.txt b/cpp/src/CMakeLists.txt new file mode 100644 index 0000000000..fd0b671379 --- /dev/null +++ b/cpp/src/CMakeLists.txt @@ -0,0 +1,32 @@ +cmake_minimum_required(VERSION 3.10) +project(ts_cpp_backend VERSION 0.1) + +set(CMAKE_CXX_STANDARD 17) +set(CMAKE_CXX_STANDARD_REQUIRED True) +set(CMAKE_CXX_EXTENSIONS OFF) + +# add subdirectories in src +add_subdirectory(src/backend) +list(APPEND EXTRA_LIBS backend) + +add_subdirectory(src/core) +list(APPEND EXTRA_LIBS core) + +add_subdirectory(src/util) +list(APPEND EXTRA_LIBS util) + +# Third-party libraries +find_package(spdlog CONFIG REQUIRED) +list(APPEND EXTRA_LIBS spdlog) + +find_package(folly CONFIG REQUIRED) +list(APPEND EXTRA_LIBS folly) + +find_package(fmt CONFIG REQUIRED) +list(APPEND EXTRA_LIBS fmt) + +include_directories("${CMAKE_INSTALL_PREFIX}/deps/include") +include_directories(${CMAKE_CURRENT_SOURCE_DIR}) + +target_link_libraries(ModelServerCPP PUBLIC ${EXTRA_LIBS}) +install(TARGETS ModelServerCPP DESTINATION bin) \ No newline at end of file diff --git a/cpp/src/backend/ts_backend.hh b/cpp/src/backend/ts_backend.hh new file mode 100644 index 0000000000..2f45106834 --- /dev/null +++ b/cpp/src/backend/ts_backend.hh @@ -0,0 +1,30 @@ +#pragma once + +#include "src/util/runtime_type.hh" + +namespace torchserve { +class TorchServeBackend { + public: + TorchServeBackend(const std::string &ts_lib_path, RuntimeType runtimeType); + + virtual ~TorchServeBackend(); + + virtual void load_model() = 0; + + virtual void predict(std::shared_ptr job) = 0; + + void ping(); + + void handleConnection(uint32_t port); + + void runServer(); + +}; + +class BackendModel { + public: + virtual ~BackendModel() = 0; + + virtual void predict(std::shared_ptr job) = 0; +}; +} // namespace torchserve \ No newline at end of file diff --git a/cpp/src/util/runtime_type.hh b/cpp/src/util/runtime_type.hh new file mode 100644 index 0000000000..a7aeaf6045 --- /dev/null +++ b/cpp/src/util/runtime_type.hh @@ -0,0 +1,31 @@ +#pragma once + +#include +#include + +namespace torchserve { + enum RuntimeType { + PYTHON, + PYTHON2, + PYTHON3, + LDP, + LSP, + }; + + const std::map runtimeType_mapping = { + {"python", PYTHON}, + {"python2", PYTHON2}, + {"python3", PYTHON3}, + {"libtorch_deploy_process", LDP}, + {"libtorch_scripted_process", LSP} + }; + + RuntimeType get_runtime_type_from_string(const std::string &type_lower_case) { + std::map::const_iterator it = runtimeType_mapping.find(type_lower_case); + + if (it == runtimeType_mapping.end()) { + // logger error + } + return it->second; + } +} From 4e1ff31a409737396d580ee4aeacf5f6f3af87b3 Mon Sep 17 00:00:00 2001 From: lxning Date: Wed, 8 Jun 2022 23:14:38 -0700 Subject: [PATCH 012/118] init code structure --- cpp/src/CMakeLists.txt | 25 +++++++------ cpp/src/backend/ts_backend.hh | 32 +++++----------- cpp/src/util/config.hh | 39 ++++++++++++++++++++ cpp/src/util/logging.hh | 30 +++++++++++++++ cpp/src/util/message.hh | 19 ++++++++++ cpp/src/util/metrics.hh | 0 cpp/src/util/model_archive.hh | 69 +++++++++++++++++++++++++++++++++++ cpp/src/util/runtime_type.hh | 31 ---------------- 8 files changed, 181 insertions(+), 64 deletions(-) create mode 100644 cpp/src/util/config.hh create mode 100644 cpp/src/util/logging.hh create mode 100644 cpp/src/util/message.hh create mode 100644 cpp/src/util/metrics.hh create mode 100644 cpp/src/util/model_archive.hh delete mode 100644 cpp/src/util/runtime_type.hh diff --git a/cpp/src/CMakeLists.txt b/cpp/src/CMakeLists.txt index fd0b671379..53a26b3180 100644 --- a/cpp/src/CMakeLists.txt +++ b/cpp/src/CMakeLists.txt @@ -1,5 +1,5 @@ cmake_minimum_required(VERSION 3.10) -project(ts_cpp_backend VERSION 0.1) +project(torchserve_cpp VERSION 0.1) set(CMAKE_CXX_STANDARD 17) set(CMAKE_CXX_STANDARD_REQUIRED True) @@ -7,26 +7,29 @@ set(CMAKE_CXX_EXTENSIONS OFF) # add subdirectories in src add_subdirectory(src/backend) -list(APPEND EXTRA_LIBS backend) +list(APPEND TS_LIBS backend) add_subdirectory(src/core) -list(APPEND EXTRA_LIBS core) +list(APPEND TS_LIBS core) + +add_subdirectory(src/protocol) +list(APPEND TS_LIBS protocol) + +add_subdirectory(src/socket) +list(APPEND TS_LIBS socket) add_subdirectory(src/util) -list(APPEND EXTRA_LIBS util) +list(APPEND TS_LIBS util) # Third-party libraries find_package(spdlog CONFIG REQUIRED) -list(APPEND EXTRA_LIBS spdlog) +list(APPEND TS_LIBS spdlog) find_package(folly CONFIG REQUIRED) -list(APPEND EXTRA_LIBS folly) +list(APPEND TS_LIBS folly) find_package(fmt CONFIG REQUIRED) -list(APPEND EXTRA_LIBS fmt) +list(APPEND TS_LIBS fmt) include_directories("${CMAKE_INSTALL_PREFIX}/deps/include") -include_directories(${CMAKE_CURRENT_SOURCE_DIR}) - -target_link_libraries(ModelServerCPP PUBLIC ${EXTRA_LIBS}) -install(TARGETS ModelServerCPP DESTINATION bin) \ No newline at end of file +include_directories(${CMAKE_CURRENT_SOURCE_DIR}) \ No newline at end of file diff --git a/cpp/src/backend/ts_backend.hh b/cpp/src/backend/ts_backend.hh index 2f45106834..5fdf270e59 100644 --- a/cpp/src/backend/ts_backend.hh +++ b/cpp/src/backend/ts_backend.hh @@ -1,30 +1,18 @@ #pragma once -#include "src/util/runtime_type.hh" +#include "src/util/config.hh" +#include "src/util/message.hh" namespace torchserve { -class TorchServeBackend { - public: - TorchServeBackend(const std::string &ts_lib_path, RuntimeType runtimeType); + class TorchServeBackend { + public: + TorchServeBackend(torchserve::ModelConfig &modelConfig); - virtual ~TorchServeBackend(); + virtual ~TorchServeBackend(); - virtual void load_model() = 0; + torchserve::Status load_model(); - virtual void predict(std::shared_ptr job) = 0; - - void ping(); - - void handleConnection(uint32_t port); - - void runServer(); - -}; - -class BackendModel { - public: - virtual ~BackendModel() = 0; - - virtual void predict(std::shared_ptr job) = 0; -}; + torchserve::InferenceResponse predict( + const torchserve::InferenceRequest &inferenceRequest); + }; } // namespace torchserve \ No newline at end of file diff --git a/cpp/src/util/config.hh b/cpp/src/util/config.hh new file mode 100644 index 0000000000..ffc1ce6bc3 --- /dev/null +++ b/cpp/src/util/config.hh @@ -0,0 +1,39 @@ +#pragma once + +#include +#include +#include + +#include "src/util/model_archive.hh" + +namespace torchserve { + struct ModelConfig { + // The model alias name. + std::string modelName; + // The path of the model file. + std::string url; + // The number of a model's copies on CPU or GPU. + uint8_t numInstances; + // The minimum number of workers distributed on this model's instances. + uint16_t minWorkers; + // The maximum number of workers distributed on this model's instances. + uint16_t maxWorkers; + // The maximum size of queue holding incoming requests for the model. + uint32_t maxQueueSize; + // The maximum etry attempts for a model incase of a failure. + uint16_t maxRetries; + // The maximum batch size in ms that a model is expected to handle. + uint16_t batchSize; + // The maximum batch delay time TorchServe waits to receive batch_size number + // of requests. + uint32_t maxBatchDelayMSec; + // The timeout in second of a model's response. + uint32_t responseTimeoutSec; + // The gpu assignment. + std::vector gpuIds; + // The runtime type. + RuntimeType runtimeType; + // The model's manifest. + Manifest manifest; + }; +} // namespace torchserve \ No newline at end of file diff --git a/cpp/src/util/logging.hh b/cpp/src/util/logging.hh new file mode 100644 index 0000000000..7b03a83a0a --- /dev/null +++ b/cpp/src/util/logging.hh @@ -0,0 +1,30 @@ +#pragma once + +#include + +namespace torchserve { + class Logger { + public: + + explicit Logger(std::string name, bool async); + virtual ~Logger() = default; + + template + void trace(std::string fmt, Args &&... args); + + template + void debug(std::string fmt, Args &&... args); + + template + void info(std::string fmt, Args &&... args); + + template + void warn(std::string fmt, Args &&... args); + + template + void error(std::string fmt, Args &&... args); + + template + void fatal(std::string fmt, Args &&... args); + }; +} // namespace torchserve \ No newline at end of file diff --git a/cpp/src/util/message.hh b/cpp/src/util/message.hh new file mode 100644 index 0000000000..fcdb66310f --- /dev/null +++ b/cpp/src/util/message.hh @@ -0,0 +1,19 @@ +#pragma once + +#incldue + +namespace torchserve { + class Status { + int code; + std::string message; + }; + + class InferenceRequest { + + }; + + class InferenceResponse { + int code; + std::string message; + }; +} // namespace torchserve \ No newline at end of file diff --git a/cpp/src/util/metrics.hh b/cpp/src/util/metrics.hh new file mode 100644 index 0000000000..e69de29bb2 diff --git a/cpp/src/util/model_archive.hh b/cpp/src/util/model_archive.hh new file mode 100644 index 0000000000..a3ead491a0 --- /dev/null +++ b/cpp/src/util/model_archive.hh @@ -0,0 +1,69 @@ +#pragma once + +#include +#include + +namespace torchserve { + enum RuntimeType { + PYTHON, + PYTHON2, + PYTHON3, + LDP, + LSP + }; + + const std::map runtimeType_mapping = { + {"python", PYTHON}, + {"python2", PYTHON2}, + {"python3", PYTHON3}, + {"libtorch_deploy_process", LDP}, + {"libtorch_scripted_process", LSP} + }; + + RuntimeType get_runtime_type_from_string(const std::string &type_lower_case) { + std::map::const_iterator it = runtimeType_mapping.find(type_lower_case); + + if (it == runtimeType_mapping.end()) { + // logger error + + } + return it->second; + } + +class Manifest { + struct Model { + std::string modelName; + std::string modelVersion; + // For legacy workflow manifest + std::string workflowName; + std::string description; + std::string handler; + std::string serializedFile; + std::string modelFile; + std::string extensions; + std::string requirementsFile; + std::string specFile; + }; + + std::string createOn; + std::string description; + std::string archiverVersion; + RuntimeType runtimeType; + Model model; +}; + +class ModelArchive { + public: + Manifest manifest; + + static ModelArchive *downloadModel( + const std::vector &allowedUrls, + std::string &modelStore, + std::string &url); + + static ModelArchive *downloadModel( + const std::vector &allowedUrls, + std::string &modelStore, + std::string &url, bool s3SseKmsEnabled); + }; +} // namespace torchserve \ No newline at end of file diff --git a/cpp/src/util/runtime_type.hh b/cpp/src/util/runtime_type.hh deleted file mode 100644 index a7aeaf6045..0000000000 --- a/cpp/src/util/runtime_type.hh +++ /dev/null @@ -1,31 +0,0 @@ -#pragma once - -#include -#include - -namespace torchserve { - enum RuntimeType { - PYTHON, - PYTHON2, - PYTHON3, - LDP, - LSP, - }; - - const std::map runtimeType_mapping = { - {"python", PYTHON}, - {"python2", PYTHON2}, - {"python3", PYTHON3}, - {"libtorch_deploy_process", LDP}, - {"libtorch_scripted_process", LSP} - }; - - RuntimeType get_runtime_type_from_string(const std::string &type_lower_case) { - std::map::const_iterator it = runtimeType_mapping.find(type_lower_case); - - if (it == runtimeType_mapping.end()) { - // logger error - } - return it->second; - } -} From a2fc68d009cc9f0eaf6e68e7ec7b9f5a201d0480 Mon Sep 17 00:00:00 2001 From: Aaqib Ansari Date: Fri, 10 Jun 2022 15:21:36 -0700 Subject: [PATCH 013/118] Init socket code and otf protocol --- cpp/src/CMakeLists.txt | 29 ++-- cpp/src/backend/CMakeLists.txt | 3 + cpp/src/backend/proc/protocol.cc | 125 ++++++++++++++++++ cpp/src/backend/proc/protocol.hh | 63 +++++++++ cpp/src/backend/torch_model_service_worker.cc | 111 ++++++++++++++++ cpp/src/backend/torch_model_service_worker.hh | 45 +++++++ cpp/src/model_service_worker.cc | 33 +++++ 7 files changed, 400 insertions(+), 9 deletions(-) create mode 100644 cpp/src/backend/CMakeLists.txt create mode 100644 cpp/src/backend/proc/protocol.cc create mode 100644 cpp/src/backend/proc/protocol.hh create mode 100644 cpp/src/backend/torch_model_service_worker.cc create mode 100644 cpp/src/backend/torch_model_service_worker.hh create mode 100644 cpp/src/model_service_worker.cc diff --git a/cpp/src/CMakeLists.txt b/cpp/src/CMakeLists.txt index 53a26b3180..79a6f16935 100644 --- a/cpp/src/CMakeLists.txt +++ b/cpp/src/CMakeLists.txt @@ -6,25 +6,36 @@ set(CMAKE_CXX_STANDARD_REQUIRED True) set(CMAKE_CXX_EXTENSIONS OFF) # add subdirectories in src -add_subdirectory(src/backend) +add_subdirectory(backend) list(APPEND TS_LIBS backend) -add_subdirectory(src/core) -list(APPEND TS_LIBS core) +# add_subdirectory(src/core) +# list(APPEND TS_LIBS core) -add_subdirectory(src/protocol) -list(APPEND TS_LIBS protocol) +# add_subdirectory(src/protocol) +# list(APPEND TS_LIBS protocol) -add_subdirectory(src/socket) -list(APPEND TS_LIBS socket) +# add_subdirectory(src/socket) +# list(APPEND TS_LIBS socket) -add_subdirectory(src/util) -list(APPEND TS_LIBS util) +# add_subdirectory(util) +# list(APPEND TS_LIBS util) + +add_executable(model_service_worker model_service_worker.cc) +target_link_libraries(model_service_worker PUBLIC ${TS_LIBS}) +target_compile_features(model_service_worker PUBLIC cxx_std_17) # Third-party libraries find_package(spdlog CONFIG REQUIRED) list(APPEND TS_LIBS spdlog) +find_package(Torch REQUIRED) +target_include_directories(model_service_worker PRIVATE ${TORCH_INCLUDE_DIRS}) +target_link_libraries(model_service_worker PRIVATE ${TORCH_LIBRARIES}) + +find_package(glog REQUIRED) +target_link_libraries(model_service_worker PRIVATE glog) + find_package(folly CONFIG REQUIRED) list(APPEND TS_LIBS folly) diff --git a/cpp/src/backend/CMakeLists.txt b/cpp/src/backend/CMakeLists.txt new file mode 100644 index 0000000000..8f89d647bc --- /dev/null +++ b/cpp/src/backend/CMakeLists.txt @@ -0,0 +1,3 @@ +FILE(GLOB BACKEND_SRC proc/*.cc *.cc) +add_library(backend SHARED ${BACKEND_SRC}) +target_link_libraries(backend PUBLIC ${TS_LIBS} stdc++fs) \ No newline at end of file diff --git a/cpp/src/backend/proc/protocol.cc b/cpp/src/backend/proc/protocol.cc new file mode 100644 index 0000000000..44119f7ec4 --- /dev/null +++ b/cpp/src/backend/proc/protocol.cc @@ -0,0 +1,125 @@ +#include "protocol.hh" + +namespace torchserve { +std::pair RetrieveMsg(Socket conn) { + char* data; + RetrieveBuffer(conn, 1, data); + char cmd = data[0]; + void* msg; + if (cmd == LOAD_MSG) + msg = RetrieveLoadMsg(conn); + else if (cmd == PREDICT_MSG) { + RetrieveInferenceMsg(conn); + std::time_t end_time = std::chrono::system_clock::to_time_t(std::chrono::system_clock::now()); + LOG(INFO) << "Backend received inference at: " << std::ctime(&end_time); + } else + LOG(ERROR) << "Invalid command: " << cmd; + return std::make_pair(cmd, msg); +} + +byte_buffer CreateLoadModelResponse(StatusCode code, const std::string& message) { + LoadModelResponse response = { + code, static_cast(message.length()), message + }; + char msg[sizeof(LoadModelResponse)]; + //std::memcpy(msg, &response, sizeof(LoadModelResponse)); +} + +void RetrieveBuffer(Socket conn, size_t length, char *data) { + char* pkt = data; + while (length > 0) { + ssize_t pkt_size = recv(conn, pkt, length, 0); + if (pkt_size == 0) { + LOG(INFO) << "Frontend disconnected."; + exit(0); + } + pkt += pkt_size; + length -= pkt_size; + } +} + +int RetrieveInt(Socket conn) { + // TODO: check network - host byte-order is correct: ntohl() and htonl() + char data[INT_STD_SIZE]; + int value; + RetrieveBuffer(conn, INT_STD_SIZE, data); + std::memcpy(&value, data, INT_STD_SIZE); + return ntohl(value); +} + +bool RetrieveBool(Socket conn) { + char data[BOOL_STD_SIZE]; + bool value; + RetrieveBuffer(conn, BOOL_STD_SIZE, data); + std::memcpy(&value, data, BOOL_STD_SIZE); + return value; +} + +LoadModelRequest* RetrieveLoadMsg(Socket conn) { + /* + * MSG Frame Format: + | cmd value | + | int model-name length | model-name value | + | int model-path length | model-path value | + | int batch-size length | + | int handler length | handler value | + | int gpu id | + | bool limitMaxImagePixels | + */ + int length; + char* data; + + // Model Name + length = torchserve::RetrieveInt(conn); + data = new char[length]; + torchserve::RetrieveBuffer(conn, length, data); + std::string model_name(data, length); + delete[] data; + + // Model Path + length = torchserve::RetrieveInt(conn); + data = new char[length]; + torchserve::RetrieveBuffer(conn, length, data); + std::string model_path(data, length); + delete[] data; + + // Batch Size + auto batch_size = torchserve::RetrieveInt(conn); + + // Handler Name (Not used) + length = torchserve::RetrieveInt(conn); + data = new char[length]; + torchserve::RetrieveBuffer(conn, length, data); + std::string handler(data, length); + delete[] data; + LOG(INFO) << "Received handler in message, will be ignored: " << handler; + + // GPU ID + auto gpu_id = torchserve::RetrieveInt(conn); + + // Envelope + length = torchserve::RetrieveInt(conn); + data = new char[length]; + torchserve::RetrieveBuffer(conn, length, data); + std::string envelope(data, length); + delete[] data; + + // Limit max image pixels + auto limit_max_image_pixels = torchserve::RetrieveBool(conn); + + auto *load_request_model = new LoadModelRequest{model_path, model_name, gpu_id, handler, envelope, batch_size, limit_max_image_pixels}; + LOG(INFO) << "Model Name: " << load_request_model->model_name; + LOG(INFO) << "Model path: " << load_request_model->model_path; + LOG(INFO) << "Batch size: " << load_request_model->batch_size; + LOG(INFO) << "Handler: " << load_request_model->handler; + LOG(INFO) << "GPU_id: " << load_request_model->gpu_id; + LOG(INFO) << "Envelope: " << load_request_model->envelope; + LOG(INFO) << "Limit max image pixels: " << load_request_model->limit_max_image_pixels; + LOG(INFO) << load_request_model; + return load_request_model; +} + +void RetrieveInferenceMsg(Socket conn) { + +} +} //namespace torchserve \ No newline at end of file diff --git a/cpp/src/backend/proc/protocol.hh b/cpp/src/backend/proc/protocol.hh new file mode 100644 index 0000000000..bca4f6636b --- /dev/null +++ b/cpp/src/backend/proc/protocol.hh @@ -0,0 +1,63 @@ +#pragma once + +#ifndef TS_CPP_BACKEND_PROTOCOL_H +#define TS_CPP_BACKEND_PROTOCOL_H + +#include +#include +#include +#include +#include +#include +#include + +namespace torchserve { +using StatusCode = int; +using Socket = int; + +typedef std::vector byte_buffer; + +//https://docs.python.org/3/library/struct.html#format-characters +#define BOOL_STD_SIZE 1 +#define INT_STD_SIZE 4 +#define LOAD_MSG 'L' +#define PREDICT_MSG 'I' + +#define LOG_CURRENT_TIMESTAMP() { \ + std::time_t time = std::chrono::system_clock::to_time_t(std::chrono::system_clock::now()); \ + std::string timestr = std::ctime(&time); \ + return timestr; \ +} + +struct LoadModelRequest { + const std::string& model_path; // /path/to/model/file + const std::string& model_name; + int gpu_id; // None if CPU else gpu_id + const std::string& handler; // Expected to be null for cpp backend + const std::string& envelope; // name of wrapper/unwrapper of request data if provided + int batch_size; + bool limit_max_image_pixels; // limit pillow image max_image_pixels +}; + +struct LoadModelResponse { + int code; + int length; + const std::string buf; +}; + +std::pair RetrieveMsg(Socket conn); +//void EncodeResponseHeaders(void resp_hdr_map); +//void CreatePredictResponse(void ret, void req_id_map, const std::string& message, StatusCode code, void context); +byte_buffer CreateLoadModelResponse(StatusCode code, const std::string& message); +void RetrieveBuffer(Socket conn, size_t length, char *data); +int RetrieveInt(Socket conn); +bool RetrieveBool(Socket conn); +LoadModelRequest* RetrieveLoadMsg(Socket conn); +void RetrieveInferenceMsg(Socket conn); +//void RetrieveRequest(Socket conn); +//void RetrieveRequestHeader(Socket conn); +//void RetrieveInputData(Socket conn); +} //namespace torchserve + + +#endif //TS_CPP_BACKEND_PROTOCOL_H diff --git a/cpp/src/backend/torch_model_service_worker.cc b/cpp/src/backend/torch_model_service_worker.cc new file mode 100644 index 0000000000..90573f5c48 --- /dev/null +++ b/cpp/src/backend/torch_model_service_worker.cc @@ -0,0 +1,111 @@ +#include "torch_model_service_worker.hh" + +namespace torchserve { +TorchModelServiceWorker::TorchModelServiceWorker( + const std::string& s_type, + const std::string& s_name, + const std::string& host_addr, + const std::string& port_num) + : sock_type_(s_type) { + unsigned short socket_family; + if (s_type == "unix") { + if (s_name.empty()) { + LOG(FATAL) << "Wrong arguments passed. No socket name given."; + } + + std::experimental::filesystem::path s_name_path(s_name); + if (remove(s_name.c_str()) != 0 && std::experimental::filesystem::exists(s_name_path)) { + LOG(FATAL) << "socket already in use: " << s_name; + } + sock_name_ = s_name; + socket_family = AF_UNIX; + } else if (s_type == "tcp") { + if (host_addr.empty()) + sock_name_ = "127.0.0.1"; + else + sock_name_ = host_addr; + if (port_num.empty()) + LOG(FATAL) << "Wrong arguments passed. No socket port given."; + port_ = htons(stoi(port_num)); + socket_family = AF_INET; + } else { + LOG(FATAL) << "Incomplete data provided"; + } + + LOG(INFO) << "Listening on port: " << s_name; + sock_ = socket(socket_family, SOCK_STREAM, 0); + if (sock_ == -1) { + LOG(FATAL) << "Failed to create socket descriptor. errno: " << errno; + } +} + +TorchModelServiceWorker::~TorchModelServiceWorker() { + // TODO: Do socket cleanup +}; + +[[noreturn]] void TorchModelServiceWorker::HandleConnection(int cl_socket) { + LOG(INFO) << "Handle connection"; + while (true) { + auto resp = torchserve::RetrieveMsg(cl_socket); + char cmd = resp.first; + void* msg = resp.second; + if (cmd == 'I') { + LOG(INFO) << "INFER request received"; + //resp = service.predict(msg) + //cl_socket.sendall(resp) + } else if (cmd == 'L') { + LOG(INFO) << "LOAD request received"; + //service, result, code = self.load_model(msg) + //resp = bytearray() + //resp += create_load_model_response(code, result) + //cl_socket.sendall(resp) + //if code != 200: + // raise RuntimeError("{} - {}".format(code, result)) + } else { + LOG(ERROR) << "Received unknown command: " << cmd; + } + } +} + +[[noreturn]] void TorchModelServiceWorker::RunServer() { + // TODO: Add sock accept timeout + int on = 1; + setsockopt(sock_, SOL_SOCKET, SO_REUSEADDR, &on, sizeof(on)); + sockaddr* srv_sock_address, client_sock_address{}; + if (sock_type_ == "unix") { + LOG(INFO) << "Binding to unix socket"; + sockaddr_un sock_addr{}; + std::memset(&sock_addr, 0, sizeof(sock_addr)); + sock_addr.sun_family = AF_UNIX; + strcpy(sock_addr.sun_path, sock_name_.c_str()); + // TODO: Fix truncation of socket name to 14 chars when casting + srv_sock_address = reinterpret_cast(&sock_addr); + } else { + LOG(INFO) << "Binding to udp socket"; + sockaddr_in sock_addr{}; + std::memset(&sock_addr, 0, sizeof(sock_addr)); + sock_addr.sin_family = AF_INET; + sock_addr.sin_port = port_; + sock_addr.sin_addr.s_addr = inet_addr(sock_name_.c_str()); + srv_sock_address = reinterpret_cast(&sock_addr); + } + + if (bind(sock_, srv_sock_address, sizeof(*srv_sock_address)) < 0) { + close(sock_); + LOG(FATAL) << "Could not bind socket. errno: " << errno; + } + listen(sock_, 1); + LOG(INFO) << "Socket bind successful"; + LOG(INFO) << "[PID]" << getpid(); + LOG(INFO) << "Torch worker started."; + + for (;;) { + socklen_t len = sizeof(client_sock_address); + auto client_sock = accept(sock_, (sockaddr *)&client_sock_address, &len); + if (client_sock < 0) + LOG(ERROR) << "Failed listening on socket. errno: " << errno; + LOG(INFO) << "Connection accepted: " << sock_name_; + HandleConnection(client_sock); + } +} +} // namespace torchserve diff --git a/cpp/src/backend/torch_model_service_worker.hh b/cpp/src/backend/torch_model_service_worker.hh new file mode 100644 index 0000000000..28b8aceaba --- /dev/null +++ b/cpp/src/backend/torch_model_service_worker.hh @@ -0,0 +1,45 @@ +#pragma once + +#ifndef TS_CPP_BACKEND_TORCH_MODEL_SERVICE_WORKER_H +#define TS_CPP_BACKEND_TORCH_MODEL_SERVICE_WORKER_H + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "proc/protocol.hh" + +namespace torchserve { + +class TorchModelServiceWorker { + public: + TorchModelServiceWorker( + const std::string& s_type, + const std::string& s_name, + const std::string& host_addr, + const std::string& port_num); + ~TorchModelServiceWorker(); + + [[noreturn]] void RunServer(); + + private: + short MAX_FAILURE_THRESHOLD = 5; + float SOCKET_ACCEPT_TIMEOUT = 30.0f; + std::string sock_type_; + std::string sock_name_; + ushort port_; + int sock_; + // LoadModel(load_model_request); + [[noreturn]] static void HandleConnection(int cl_socket); +}; + +} // namespace torchserve + + +#endif //TS_CPP_BACKEND_TORCH_MODEL_SERVICE_WORKER_H \ No newline at end of file diff --git a/cpp/src/model_service_worker.cc b/cpp/src/model_service_worker.cc new file mode 100644 index 0000000000..ffcf8ff1a4 --- /dev/null +++ b/cpp/src/model_service_worker.cc @@ -0,0 +1,33 @@ +#include +#include +#include +#include + +#include "backend/torch_model_service_worker.hh" + + +int main(int argc, const char* argv[]) { + // Init logging + google::InitGoogleLogging("ts_cpp_backend"); + FLAGS_logtostderr = 1; + // TODO: Set logging format same as python worker + LOG(INFO) << "Initializing Libtorch backend worker..."; + + // Test libtorch dependency + /*torch::jit::script::Module module; + try { + LOG(INFO) << "Loading model file from " << argv[1]; + module = torch::jit::load(argv[1]); + } + catch (const c10::Error& e) { + LOG(ERROR) << "Error loading the model\n"; + return -1; + } + + LOG(INFO) << "Model loaded\n";*/ + + std::string s_type("unix"); + std::unique_ptr worker = std::make_unique( + "unix", "/tmp/.9000", "127.0.0.1", ""); + worker->RunServer(); +} \ No newline at end of file From f5afa460ac031ce8a810a8c214892b8b3f6e5563 Mon Sep 17 00:00:00 2001 From: lxning Date: Wed, 22 Jun 2022 23:08:16 -0700 Subject: [PATCH 014/118] add log api --- cpp/src/util/config.hh | 27 +++++++------- cpp/src/util/logging.hh | 67 +++++++++++++++++++++++------------ cpp/src/util/message.hh | 9 +++-- cpp/src/util/model_archive.hh | 19 +++++----- 4 files changed, 77 insertions(+), 45 deletions(-) diff --git a/cpp/src/util/config.hh b/cpp/src/util/config.hh index ffc1ce6bc3..fe3bc57b91 100644 --- a/cpp/src/util/config.hh +++ b/cpp/src/util/config.hh @@ -1,38 +1,39 @@ -#pragma once +#ifndef CPP_UTIL_CONFIG_HH_ +#define CPP_UTIL_CONFIG_HH_ #include #include #include -#include "src/util/model_archive.hh" +#include "util/model_archive.hh" namespace torchserve { struct ModelConfig { // The model alias name. - std::string modelName; + std::string model_name; // The path of the model file. std::string url; // The number of a model's copies on CPU or GPU. - uint8_t numInstances; + uint8_t num_instances; // The minimum number of workers distributed on this model's instances. - uint16_t minWorkers; + uint16_t min_workers; // The maximum number of workers distributed on this model's instances. - uint16_t maxWorkers; + uint16_t max_workers; // The maximum size of queue holding incoming requests for the model. - uint32_t maxQueueSize; + uint32_t max_queue_size; // The maximum etry attempts for a model incase of a failure. - uint16_t maxRetries; + uint16_t max_retries; // The maximum batch size in ms that a model is expected to handle. - uint16_t batchSize; + uint16_t batch_size; // The maximum batch delay time TorchServe waits to receive batch_size number // of requests. - uint32_t maxBatchDelayMSec; + uint32_t max_batch_delay_msec; // The timeout in second of a model's response. - uint32_t responseTimeoutSec; + uint32_t response_timeout_sec; // The gpu assignment. - std::vector gpuIds; + std::vector gpu_ids; // The runtime type. - RuntimeType runtimeType; + RuntimeType runtime_type; // The model's manifest. Manifest manifest; }; diff --git a/cpp/src/util/logging.hh b/cpp/src/util/logging.hh index 7b03a83a0a..024afaf5af 100644 --- a/cpp/src/util/logging.hh +++ b/cpp/src/util/logging.hh @@ -1,30 +1,53 @@ -#pragma once +#ifndef CPP_UTIL_LOGGING_HH_ +#define CPP_UTIL_LOGGING_HH_ +#include +#include +#include #include namespace torchserve { + struct LoggerConfig { + std::string logger_category, + std::vector sink_paths, + std::string log_prefix_format, + bool async + }; + + // TorchServe Logger API class Logger { public: + Logger(const LoggerConfig& config); + virtual ~Logger() = 0; + + virtual void Trace(const std::string& message) = 0; + virtual void Debug(const std::string& message) = 0; + virtual void Info(const std::string& message) = 0; + virtual void Warn(const std::string& message) = 0; + virtual void Error(const std::string& message) = 0; + virtual void Fatal(const std::string& message) = 0; + }; - explicit Logger(std::string name, bool async); - virtual ~Logger() = default; - - template - void trace(std::string fmt, Args &&... args); - - template - void debug(std::string fmt, Args &&... args); - - template - void info(std::string fmt, Args &&... args); - - template - void warn(std::string fmt, Args &&... args); - - template - void error(std::string fmt, Args &&... args); - - template - void fatal(std::string fmt, Args &&... args); + // A Singleton class + class LoggerStore { + public: + static LoggerStore& GetInstance(); + LoggerStore(const LoggerStore&) = delete; + LoggerStore &operator=(const LoggerStore&) = delete; + + void RegisterLogger(std::shared_ptr new_logger); + std::shared_ptr GetLogger(const std::string& logger_category); + void drop(const std::string& logger_category); + + private: + LoggerStore(); + ~LoggerStore(); + + + // key: logger_category + // value: Logger + std::map> logger_table_; + std::mutex logger_table_mutex_, }; -} // namespace torchserve \ No newline at end of file +} // namespace torchserve +#endif // CPP_UTIL_LOGGING_HH_ \ No newline at end of file diff --git a/cpp/src/util/message.hh b/cpp/src/util/message.hh index fcdb66310f..a84772101a 100644 --- a/cpp/src/util/message.hh +++ b/cpp/src/util/message.hh @@ -1,6 +1,8 @@ -#pragma once -#incldue +#ifndef CPP_UTIL_MESSAGE_HH_ +#define CPP_UTIL_MESSAGE_HH_ + +#include namespace torchserve { class Status { @@ -8,6 +10,9 @@ namespace torchserve { std::string message; }; + class LoadRequest { + + } class InferenceRequest { }; diff --git a/cpp/src/util/model_archive.hh b/cpp/src/util/model_archive.hh index a3ead491a0..3e8f515343 100644 --- a/cpp/src/util/model_archive.hh +++ b/cpp/src/util/model_archive.hh @@ -1,7 +1,10 @@ -#pragma once +#ifndef CPP_UTIL_MODEL_ARCHIVE_HH_ +#define CPP_UTIL_MODEL_ARCHIVE_HH_ +#include #include #include +#include namespace torchserve { enum RuntimeType { @@ -12,7 +15,7 @@ namespace torchserve { LSP }; - const std::map runtimeType_mapping = { + const std::map runtime_type_table = { {"python", PYTHON}, {"python2", PYTHON2}, {"python3", PYTHON3}, @@ -20,12 +23,11 @@ namespace torchserve { {"libtorch_scripted_process", LSP} }; - RuntimeType get_runtime_type_from_string(const std::string &type_lower_case) { - std::map::const_iterator it = runtimeType_mapping.find(type_lower_case); + RuntimeType GetRuntimeType(const std::string& type_lower_case) { + std::map::const_iterator it = runtime_type_table.find(type_lower_case); - if (it == runtimeType_mapping.end()) { - // logger error - + if (it == runtime_type_table.end()) { + throw std::invalid_argument(fmt::format("invalid runtime type: {}", type_lower_case)); } return it->second; } @@ -66,4 +68,5 @@ class ModelArchive { std::string &modelStore, std::string &url, bool s3SseKmsEnabled); }; -} // namespace torchserve \ No newline at end of file +} // namespace torchserve +#endif // CPP_UTIL_MODEL_ARCHIVE_HH_ \ No newline at end of file From 129899aefb8b303cc71295c0b26d6df98db6308a Mon Sep 17 00:00:00 2001 From: lxning Date: Sun, 3 Jul 2022 20:24:19 -0700 Subject: [PATCH 015/118] decouple backend and model worker; impl torchscript load model; build scripts [ci skip] --- .gitignore | 4 + cpp/CMakeLists.txt | 27 + cpp/Doxyfile | 2593 +++++++++++++++++ cpp/build.sh | 252 ++ cpp/src/backend/CMakeLists.txt | 3 - cpp/src/backend/proc/protocol.cc | 125 - cpp/src/backend/proc/protocol.hh | 63 - cpp/src/backend/torch_model_service_worker.cc | 111 - cpp/src/backend/torch_model_service_worker.hh | 45 - cpp/src/backend/ts_backend.hh | 18 - cpp/src/backends/CMakeLists.txt | 47 + cpp/src/backends/core/backend.cc | 15 + cpp/src/backends/core/backend.hh | 82 + cpp/src/backends/process/model_worker.cc | 128 + cpp/src/backends/process/model_worker.hh | 78 + .../backends/process/model_worker_socket.cc | 32 + cpp/src/backends/protocol/otf_message.cc | 133 + cpp/src/backends/protocol/otf_message.hh | 43 + .../torch_scripted/torch_scripted_backend.cc | 72 + .../torch_scripted/torch_scripted_backend.hh | 45 + cpp/src/model_service_worker.cc | 33 - cpp/src/util/config.hh | 40 - cpp/src/util/logging.hh | 53 - cpp/src/util/message.hh | 24 - cpp/src/util/metrics.hh | 0 cpp/src/util/model_archive.hh | 72 - cpp/src/utils/CMakeLists.txt | 7 + cpp/src/utils/config.cc | 28 + cpp/src/utils/config.hh | 97 + cpp/src/utils/logging.hh | 36 + cpp/src/utils/message.hh | 53 + cpp/src/utils/metrics.hh | 6 + cpp/src/utils/model_archive.hh | 50 + 33 files changed, 3828 insertions(+), 587 deletions(-) create mode 100644 cpp/CMakeLists.txt create mode 100644 cpp/Doxyfile create mode 100755 cpp/build.sh delete mode 100644 cpp/src/backend/CMakeLists.txt delete mode 100644 cpp/src/backend/proc/protocol.cc delete mode 100644 cpp/src/backend/proc/protocol.hh delete mode 100644 cpp/src/backend/torch_model_service_worker.cc delete mode 100644 cpp/src/backend/torch_model_service_worker.hh delete mode 100644 cpp/src/backend/ts_backend.hh create mode 100644 cpp/src/backends/CMakeLists.txt create mode 100644 cpp/src/backends/core/backend.cc create mode 100644 cpp/src/backends/core/backend.hh create mode 100644 cpp/src/backends/process/model_worker.cc create mode 100644 cpp/src/backends/process/model_worker.hh create mode 100644 cpp/src/backends/process/model_worker_socket.cc create mode 100644 cpp/src/backends/protocol/otf_message.cc create mode 100644 cpp/src/backends/protocol/otf_message.hh create mode 100644 cpp/src/backends/torch_scripted/torch_scripted_backend.cc create mode 100644 cpp/src/backends/torch_scripted/torch_scripted_backend.hh delete mode 100644 cpp/src/model_service_worker.cc delete mode 100644 cpp/src/util/config.hh delete mode 100644 cpp/src/util/logging.hh delete mode 100644 cpp/src/util/message.hh delete mode 100644 cpp/src/util/metrics.hh delete mode 100644 cpp/src/util/model_archive.hh create mode 100644 cpp/src/utils/CMakeLists.txt create mode 100644 cpp/src/utils/config.cc create mode 100644 cpp/src/utils/config.hh create mode 100644 cpp/src/utils/logging.hh create mode 100644 cpp/src/utils/message.hh create mode 100644 cpp/src/utils/metrics.hh create mode 100644 cpp/src/utils/model_archive.hh diff --git a/.gitignore b/.gitignore index 78c5de50eb..816dfb9442 100644 --- a/.gitignore +++ b/.gitignore @@ -32,3 +32,7 @@ instances.yaml.backup ## Models *.pt + +# cpp +cpp/_build +cpp/third-party diff --git a/cpp/CMakeLists.txt b/cpp/CMakeLists.txt new file mode 100644 index 0000000000..9564ed3285 --- /dev/null +++ b/cpp/CMakeLists.txt @@ -0,0 +1,27 @@ +cmake_minimum_required(VERSION 3.14 FATAL_ERROR) +project(torchserve_cpp VERSION 0.1) + +set(CMAKE_CXX_STANDARD 17) +set(CMAKE_CXX_STANDARD_REQUIRED True) +set(CMAKE_CXX_EXTENSIONS OFF) +set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall") + +find_package(Boost REQUIRED) +find_package(folly REQUIRED) +find_package(fmt REQUIRED) +find_package(gflags REQUIRED) +find_package(glog REQUIRED) +find_package(Torch REQUIRED) +set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${TORCH_CXX_FLAGS}") + +include_directories(${Torch_INCLUDE_DIRS}) +include_directories(${FOLLY_INCLUDE_DIRS}) + +include_directories("${CMAKE_INSTALL_PREFIX}/_deps") +include_directories(${CMAKE_CURRENT_SOURCE_DIR}) + +set(FOLLY_LIBRARIES Folly::folly) + +# add subdirectories in src +add_subdirectory(src/utils) +add_subdirectory(src/backends) diff --git a/cpp/Doxyfile b/cpp/Doxyfile new file mode 100644 index 0000000000..01ed3f3350 --- /dev/null +++ b/cpp/Doxyfile @@ -0,0 +1,2593 @@ +# Doxyfile 1.9.2 + +# 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 configuration +# 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 +# https://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 = "torchserve_cpp" + +# 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 = + +# 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 JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = 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 + +# By default Python docstrings are displayed as preformatted text and doxygen's +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the +# doxygen's special commands can be used and the contents of the docstring +# documentation blocks is shown as doxygen documentation. +# The default value is: YES. + +PYTHON_DOCSTRING = YES + +# 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 = 4 + +# 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:^^" +# 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:". Note that you cannot put \n's in the value part of an alias +# to insert newlines (in the resulting output). You can put ^^ in the value part +# of an alias to insert a newline as if a physical newline was in the original +# file. When you need a literal { or } or , in the value part of an alias you +# have to escape them by means of a backslash (\), this can lead to conflicts +# with the commands \{ and \} for these it is advised to use the version @{ and +# @} or use a double escape (\\{ and \\}) + +ALIASES = + +# 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 + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = 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, +# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, +# VHDL, 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). 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. When specifying no_extension you should add +# * to the FILE_PATTERNS. +# +# Note see also the list of default file extension mappings. + +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 https://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: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 5 + +# 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: +# https://www.riverbankcomputing.com/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 + +# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use +# during processing. When set to 0 doxygen will based this on the number of +# cores available in the system. You can set it explicitly to a value larger +# than 0 to get more control over the balance between CPU load and processing +# speed. At this moment only the input processing can be done using multiple +# threads. Since this is still an experimental feature the default is set to 1, +# which effectively disables parallel processing. Please report any issues you +# encounter. Generating dot graphs in parallel is controlled by the +# DOT_NUM_THREADS setting. +# Minimum value: 0, maximum value: 32, default value: 1. + +NUM_PROC_THREADS = 1 + +#--------------------------------------------------------------------------- +# 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 = YES + +# 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_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = 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 = YES + +# 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 = YES + +# 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 = YES + +# 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 this flag is set to YES, the name of an unnamed parameter in a declaration +# will be determined by the corresponding definition. By default unnamed +# parameters remain unnamed in the output. +# The default value is: YES. + +RESOLVE_UNNAMED_PARAMS = YES + +# 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 +# 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 + +# With the correct setting of option CASE_SENSE_NAMES doxygen will better be +# able to match the capabilities of the underlying filesystem. In case the +# filesystem is case sensitive (i.e. it supports files in the same directory +# whose names only differ in casing), the option must be set to YES to properly +# deal with such files in case they appear in the input. For filesystems that +# are not case sensitive the option should be be set to NO to properly deal with +# output files written for symbols that only differ in casing, such as for two +# classes, one named CLASS and the other named Class, and to also support +# references to files without having to specify the exact matching casing. On +# Windows (including Cygwin) and MacOS, users should typically set this option +# to NO, whereas on Linux or other Unix flavors it should typically be set to +# YES. +# The default value is: system dependent. + +CASE_SENSE_NAMES = NO + +# 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_HEADERFILE tag is set to YES then the documentation for a class +# will show which file needs to be included to use the class. +# The default value is: YES. + +SHOW_HEADERFILE = YES + +# 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. See also section "Changing the +# layout of pages" for information. +# +# 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 https://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 documenting some parameters in +# a documented function twice, or documenting parameters that don't exist or +# using markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete +# function parameter documentation. If set to NO, doxygen will accept that some +# parameters have no documentation without warning. +# The default value is: YES. + +WARN_IF_INCOMPLETE_DOC = 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 parameter +# documentation, but not about the absence of documentation. If EXTRACT_ALL is +# set to YES then this flag will automatically be disabled. See also +# WARN_IF_INCOMPLETE_DOC +# 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. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS +# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the doxygen process doxygen will return with a non-zero status. +# Possible values are: NO, YES and FAIL_ON_WARNINGS. +# 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 = /Users/lninga/workplace/python_env/serve/cpp/src/ + +# 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: +# https://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. +# +# Note the list of default checked file patterns might differ from the list of +# default file extension mappings. +# +# 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++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, +# *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C +# comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, +# *.vhdl, *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = *.c *.hh + +# 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 +# entity 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 = YES + +# 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 https://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 configuration 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 + +#--------------------------------------------------------------------------- +# 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 + +# 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 color-wheel, see +# https://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 gray-scales 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_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# 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: +# https://developer.apple.com/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 https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.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 +# on Windows. In the beginning of 2021 Microsoft took the original page, with +# a.o. the download links, offline the HTML help workshop was already many years +# in maintenance mode). You can download the HTML help workshop from the web +# archives at Installation executable (see: +# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo +# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). +# +# 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 main .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: +# https://doc.qt.io/archives/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: +# https://doc.qt.io/archives/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: +# https://doc.qt.io/archives/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: +# https://doc.qt.io/archives/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: +# https://doc.qt.io/archives/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 (absolute path +# including file name) 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 (see "Fine-tuning the output"). 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 + +# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the +# FULL_SIDEBAR option determines if the side bar is limited to only the treeview +# area (value NO) or if it should extend to the full height of the window (value +# YES). Setting this to YES gives a layout similar to +# https://docs.readthedocs.io with more room for contents, but less room for the +# project logo, title, and description. If either GENERATOR_TREEVIEW or +# DISABLE_INDEX is set to NO, this option has no effect. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FULL_SIDEBAR = YES + +# 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 + +# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for +# the HTML output. These images will generally look nicer at scaled resolutions. +# Possible values are: png (the default) and svg (looks nicer but requires the +# pdf2svg or inkscape tool). +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = png + +# 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_TRANSPARENT 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 + +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://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 + +# With MATHJAX_VERSION it is possible to specify the MathJax version to be used. +# Note that the different versions of MathJax have different requirements with +# regards to the different settings, so it is possible that also other MathJax +# settings have to be changed when switching between the different MathJax +# versions. +# Possible values are: MathJax_2 and MathJax_3. +# The default value is: MathJax_2. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_VERSION = MathJax_2 + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. For more details about the output format see MathJax +# version 2 (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 +# (see: +# http://docs.mathjax.org/en/latest/web/components/output.html). +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility. This is the name for Mathjax version 2, for MathJax version 3 +# this will be translated into chtml), NativeMML (i.e. MathML. Only supported +# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This +# is the name for Mathjax version 3, for MathJax version 2 this will be +# translated into HTML-CSS) 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 https://www.mathjax.org before deployment. The default value is: +# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 +# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# for MathJax version 2 (see https://docs.mathjax.org/en/v2.7-latest/tex.html +# #tex-and-latex-extensions): +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# For example for MathJax version 3 (see +# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): +# MATHJAX_EXTENSIONS = ams +# 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/v2.7-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 +# , /