Skip to content

tutorial, clean code etc. #3

@phiwei

Description

@phiwei

Hi,

thank you for the implementation, I will maybe test it in my project. While your paper shows interesting results regarding speed-up, you describe the code as "usable right out of the box". This is not true with the current documentation and code structure.

I would suggest:

  • add a requirements file
  • add proper usage examples for different cases, with example links to where to download example images
  • improve documentation (comment the functions, both with a header per function as well as within the code)

Otherwise, the quality of the code invokes no confidence in the quality of its results.
Best wishes

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions