Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme.md: build and usage guide inconsistent #123

Open
thomas725 opened this issue Nov 6, 2021 · 3 comments
Open

Readme.md: build and usage guide inconsistent #123

thomas725 opened this issue Nov 6, 2021 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@thomas725
Copy link

thomas725 commented Nov 6, 2021

Your build guide tells to build in a separate subfolder "build", but the usage guide assumes that the built backscrub binary is in the same folder as the models directory

To make the usage guide compatible with the build guide, you either have to add the path to the model:

./backscrub -d -d -c /dev/video0 -v /dev/video10 -m ../models/selfiesegmentation_mlkit-256x256-2021_01_19-v1215.f16.tflite -b ../images/background_bauhaus.png

or you start it from outside the build directory:

build/backscrub -d -d -c /dev/video0 -v /dev/video10 -b images/background_bauhaus.png
@BenBE BenBE added the documentation Improvements or additions to documentation label Nov 6, 2021
@BenBE
Copy link
Collaborator

BenBE commented Nov 6, 2021

It's more complicated than that, actually. ;-) There is some magic on IIRC experimental (soon to lang on main) that goes without the paths completely and looks for those directories itself. So you would need relative paths only if things were outside the default directories of the tool.

@phlash
Copy link
Collaborator

phlash commented Nov 7, 2021

It's probably a hangover from the Makefile build that dropped the binary in $cwd and which I think we ought to retire as it's not feature compatible with the CMake build (no XNNPACK support).

That said - it always helps to have working cut'n paste docs 😄

@phlash
Copy link
Collaborator

phlash commented Dec 16, 2021

Related to #127, when the README.md gets updated there we should fix this (if required)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants