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

Propose a unified VPR framework/class UML #1

Open
GabeBolton opened this issue Apr 19, 2023 · 1 comment
Open

Propose a unified VPR framework/class UML #1

GabeBolton opened this issue Apr 19, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@GabeBolton
Copy link
Collaborator

Create a high-level UML diagram to describe the interfaces of the VPR class.

@GabeBolton GabeBolton added documentation Improvements or additions to documentation enhancement New feature or request labels Apr 19, 2023
@GabeBolton GabeBolton added this to the Unify VPR Framework milestone Apr 19, 2023
@GabeBolton GabeBolton self-assigned this Apr 19, 2023
GabeBolton added a commit that referenced this issue Apr 19, 2023
@GabeBolton
Copy link
Collaborator Author

GabeBolton commented Apr 19, 2023

@carson-sky @owenclaxton-QUT When you get a chance, let me know what feedback you have on that commit.

A few initial thoughts could be:

  • Is the added 'cleanness' of having VPR.ref and VPR.query as attributes of the VPR class worthwhile when we already should have all the data in the included VPRImageProcessor object, e.g. VPR.vip.IMG_FEATS, VPR.vip.ODOM, etc?
    • If not, should the VPR.set_query_matches method for calculating the true query matches (e.g. based on odometry distance or file index) be moved into VPRImageProcessor?
  • Do we want to have a unified Integrity.train() method, or do we anticipate training setup being different enough for each integrity subclass that we would need to rewrite it with different inputs every time?
  • Could we just add distance and match calculation into VPRImageProcessor and not have a separate VPR class that subclasses are based on?

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 enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant