aboutsummaryrefslogtreecommitdiff
path: root/docs/user_guide/gaze_analysis_pipeline/configuration_and_execution.md
diff options
context:
space:
mode:
authorThéo de la Hogue2024-04-10 12:37:08 +0200
committerThéo de la Hogue2024-04-10 12:37:08 +0200
commitc03097c7b8e9b3fbbe188c0c99908fae2b28ba37 (patch)
treec7a5d1db9d65e27db19c0f91d74c8cd3202ffc8a /docs/user_guide/gaze_analysis_pipeline/configuration_and_execution.md
parentf3a09d79cafef66693c1792d21d722870ab53dc7 (diff)
downloadargaze-c03097c7b8e9b3fbbe188c0c99908fae2b28ba37.zip
argaze-c03097c7b8e9b3fbbe188c0c99908fae2b28ba37.tar.gz
argaze-c03097c7b8e9b3fbbe188c0c99908fae2b28ba37.tar.bz2
argaze-c03097c7b8e9b3fbbe188c0c99908fae2b28ba37.tar.xz
Adding new argaze.load package function to ease the access to DataFeatures.from_json function.
Diffstat (limited to 'docs/user_guide/gaze_analysis_pipeline/configuration_and_execution.md')
-rw-r--r--docs/user_guide/gaze_analysis_pipeline/configuration_and_execution.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/user_guide/gaze_analysis_pipeline/configuration_and_execution.md b/docs/user_guide/gaze_analysis_pipeline/configuration_and_execution.md
index 7fbbef0..47b820b 100644
--- a/docs/user_guide/gaze_analysis_pipeline/configuration_and_execution.md
+++ b/docs/user_guide/gaze_analysis_pipeline/configuration_and_execution.md
@@ -7,7 +7,7 @@ The [ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame) class defines a rectan
## Load JSON configuration file
-The [ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame) internal pipeline is entirely customizable from a JSON configuration file thanks to [ArFrame.from_json](../../argaze.md/#argaze.ArFeatures.ArFrame.from_json) class method.
+An [ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame) pipeline can be loaded from a JSON configuration file thanks to [argaze.load](../../argaze.md/#argaze.load) package method.
Here is a simple JSON [ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame) configuration file example:
@@ -36,10 +36,10 @@ Here is a simple JSON [ArFrame](../../argaze.md/#argaze.ArFeatures.ArFrame) conf
Then, here is how to load the JSON file:
```python
-from argaze import ArFeatures
+import argaze
# Load ArFrame
-with ArFeatures.ArFrame.from_json('./configuration.json') as ar_frame:
+with argaze.load('./configuration.json') as ar_frame:
# Do something with ArFrame
...