diff options
Diffstat (limited to 'docs/user_guide/gaze_analysis_pipeline')
| -rw-r--r-- | docs/user_guide/gaze_analysis_pipeline/advanced_topics/module_loading.md | 4 | ||||
| -rw-r--r-- | docs/user_guide/gaze_analysis_pipeline/configuration_and_execution.md | 6 |
2 files changed, 5 insertions, 5 deletions
diff --git a/docs/user_guide/gaze_analysis_pipeline/advanced_topics/module_loading.md b/docs/user_guide/gaze_analysis_pipeline/advanced_topics/module_loading.md index fb717b6..0e439a9 100644 --- a/docs/user_guide/gaze_analysis_pipeline/advanced_topics/module_loading.md +++ b/docs/user_guide/gaze_analysis_pipeline/advanced_topics/module_loading.md @@ -37,13 +37,13 @@ To do so, simply prepend the package where to find the module into the JSON conf Then, load your package from the python script where the [ArFrame](../../../argaze.md/#argaze.ArFeatures.ArFrame) is created. ```python -from argaze import ArFeatures +import argaze # Import your own package import my_package # Load ArFrame -with ArFeatures.ArFrame.from_json('./configuration.json') as ar_frame: +with argaze.load('./configuration.json') as ar_frame: # Print ArFrame attributes for module, scan_path_analyzer in ar_frame.scan_path_analyzers.items(): 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 ... |