search

visual-layer / fastdup

fastdup is a powerful free tool designed to rapidly extract valuable insights from your image & video datasets. Assisting you to increase your dataset images & labels quality and reduce your data operations costs at an unparalleled scale.
Other
1.56k stars 76 forks source link

[Bug]: search should be documented better #172

Closed dbickson closed 1 year ago

dbickson commented 1 year ago

What happened?

Need end to end example, mentioning that it needs a free sign up for fastdup beta version

What did you expect to see?

No response

What version of fastdup were you runnning on?

0.922

What version of Python were you running on?

Python 3.8

Operating System

All

Reproduction steps

No response

Relevant log output

No response

Attach a screenshot [Optional]

No response

Contact Details [Optional]

No response

dnth commented 1 year ago

Assign this to me :)

dbickson commented 1 year ago

Thanks @dnth this is the latest api:

        Example:
        >>> import fastdup
        >>> input_dir = "/my/input/dir"
        >>> work_dir = /my/work/dir"
        >>> fastdup.run(input_dir, work_dir)
        # point to the work_dir where fastdup was run
        >>> fastdup.init_search(10, work_dir, verbose=True, license=<my license>)
        # The below code can be executed multiple times, each time with a new searched image
        >>> df = fastdup.search("myimage.jpg", None, verbose=True)
        # optional: display search output
        >>> fastdup.create_duplicates_gallery(df, ".",input_dir=input_dir)