doc: update docstring and tesseract input/output handling

[imMoya]

• 1. Fix docstring
• 2. Input/output handling
• 3. Update README with information on how to train with gpu

Relevant issue or PR

Description of changes

1. Fix docstring

Function sample_points_with_spheres did not adhere to the docstring format indemo/_showcase/ansys-qoi/qoi_dataset/scripts/process/utils.py. This PR unifies docstring format.

2. Input/output handling

• Change typing toInputFileReference and OutputFileReference when possible. When Tesseract contains a folder path as input value, these variables are still considered str. Changing this would require a change of logic, which could be considered in future improvements
• Inside the evaluate function, and in order to work with --input_path and --output_path, the following lines have been implemented to build Path variables and enable writing of files to local disk.

config = get_config()
input_base = Path(config.input_path)
output_base = Path(config.output_path) 

3. Update README with information on how to train with gpu

Testing done

CPU execution

• qoi_dataset/main.py
• qoi_train/main.py
• qoi_inference/main.py
• workflow.py

GPU execution

• qoi_dataset/main.py
• qoi_train/main.py
• qoi_inference/main.py
• workflow.py

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 76.72%. Comparing base (7a33ab5) to head (31ffa71).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #412      +/-   ##
==========================================
+ Coverage   66.87%   76.72%   +9.85%     
==========================================
  Files          29       29              
  Lines        3420     3420              
  Branches      533      533              
==========================================
+ Hits         2287     2624     +337     
+ Misses        941      563     -378     
- Partials      192      233      +41     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[imMoya]

@xalelax could you please review the lines implemented in the README for GPU acceleration of the workflow? I tried building images of the Tesseract on an Azure VM GPU but even with 30GB available it seems to run out of memory...