diff options
author | Théo de la Hogue | 2024-04-22 14:31:24 +0200 |
---|---|---|
committer | Théo de la Hogue | 2024-04-22 14:31:24 +0200 |
commit | e7344955a1368c24c55fc12b2cb9ff2582278785 (patch) | |
tree | 88b7da7f34318c5eb69f0ed810e2c518d0f0f9b7 /docs/user_guide/pipeline_input_context/configuration_and_connection.md | |
parent | 191da6950e7d4e9a7822b779ffb41dec3a1b7cb5 (diff) | |
download | argaze-e7344955a1368c24c55fc12b2cb9ff2582278785.zip argaze-e7344955a1368c24c55fc12b2cb9ff2582278785.tar.gz argaze-e7344955a1368c24c55fc12b2cb9ff2582278785.tar.bz2 argaze-e7344955a1368c24c55fc12b2cb9ff2582278785.tar.xz |
First work around ArContext documentation.
Diffstat (limited to 'docs/user_guide/pipeline_input_context/configuration_and_connection.md')
-rw-r--r-- | docs/user_guide/pipeline_input_context/configuration_and_connection.md | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/user_guide/pipeline_input_context/configuration_and_connection.md b/docs/user_guide/pipeline_input_context/configuration_and_connection.md new file mode 100644 index 0000000..392860f --- /dev/null +++ b/docs/user_guide/pipeline_input_context/configuration_and_connection.md @@ -0,0 +1,35 @@ +Load and connect a context +========================== + +Once an [ArContext is defined](context_definition.md), it have to be connected to a pipeline. + +# Load JSON configuration file + +An [ArContext](../../argaze.md/#argaze.ArFeatures.ArContext) can be loaded from a JSON configuration file thanks to the argaze.load package method. + +Here is a JSON configuration file related to the [previously defined Example context](context_definition.md): + +```json +{ + "my_context.Example": { + "name": "My example context", + "parameter": ..., + "pipeline": "pipeline.json" + } +} +``` + +Then, here is how to load the JSON file: + +```python +import argaze + +# Load ArContext +with argaze.load('./configuration.json') as ar_context: + + # Do something with ArContext + ... +``` + +!!! note + There is nothing to do to execute a loaded context as it is handled inside its own **__enter__** method. |