From c03097c7b8e9b3fbbe188c0c99908fae2b28ba37 Mon Sep 17 00:00:00 2001
From: Théo de la Hogue
Date: Wed, 10 Apr 2024 12:37:08 +0200
Subject: Adding new argaze.load package function to ease the access to
 DataFeatures.from_json function.

---
 .../aruco_markers_pipeline/configuration_and_execution.md           | 6 +++---
 .../gaze_analysis_pipeline/advanced_topics/module_loading.md        | 4 ++--
 .../gaze_analysis_pipeline/configuration_and_execution.md           | 6 +++---
 3 files changed, 8 insertions(+), 8 deletions(-)

(limited to 'docs')

diff --git a/docs/user_guide/aruco_markers_pipeline/configuration_and_execution.md b/docs/user_guide/aruco_markers_pipeline/configuration_and_execution.md
index 885db50..dd36ed3 100644
--- a/docs/user_guide/aruco_markers_pipeline/configuration_and_execution.md
+++ b/docs/user_guide/aruco_markers_pipeline/configuration_and_execution.md
@@ -9,7 +9,7 @@ As [ArUcoCamera](../../argaze.md/#argaze.ArUcoMarkers.ArUcoCamera) inherits from
 
 ## Load JSON configuration file
 
-The [ArUcoCamera](../../argaze.md/#argaze.ArUcoMarkers.ArUcoCamera) internal pipeline loads from a JSON configuration file thanks to [ArUcoCamera.from_json](../../argaze.md/#argaze.ArUcoMarkers.ArUcoCamera.from_json) class method. 
+An [ArUcoCamera](../../argaze.md/#argaze.ArUcoMarkers.ArUcoCamera) pipeline can be loaded from a JSON configuration file thanks to [argaze.load](../../argaze.md/#argaze.load) package method. 
 
 Here is a simple JSON [ArUcoCamera](../../argaze.md/#argaze.ArUcoMarkers.ArUcoCamera) configuration file example:
 
@@ -53,10 +53,10 @@ Here is a simple JSON [ArUcoCamera](../../argaze.md/#argaze.ArUcoMarkers.ArUcoCa
 Then, here is how to load the JSON file:
 
 ```python
-from argaze.ArUcoMarkers import ArUcoCamera
+import argaze
 
 # Load ArUcoCamera
-with ArUcoCamera.ArUcoCamera.from_json('./configuration.json') as aruco_camera:
+with argaze.load('./configuration.json') as aruco_camera:
 
     # Do something with ArUcoCamera
     ...
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
 	...
-- 
cgit v1.1