diff --git a/README.md b/README.md index 2db1fed..af23629 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,8 @@ A simple demonstration can be achieved by creating a new scene in Unity, adding python facetracker.py --visualize 3 --pnp-points 1 --max-threads 4 -c video.mp4 +__Note__: If dependencies were installed using [poetry](https://python-poetry.org/), they have to be launched from a `poetry shell` or have to be prefixed with `poetry run`. + This way the tracking script will output its own tracking visualization while also demonstrating the transmission of tracking data to Unity. The included `OpenSeeLauncher` component allows starting the face tracker program from Unity. It is designed to work with the pyinstaller created executable distributed in the binary release bundles. It provides three public API functions: @@ -131,6 +133,12 @@ The required libraries can be installed using pip: pip install onnxruntime opencv-python pillow numpy +Alternatively poetry can be used to +install all dependencies for this project in a separate virtual env: + + poetry install + + # References ## Training dataset