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

Rename tasks #82

Closed
kmcdono2 opened this issue Feb 20, 2023 · 2 comments · Fixed by #95
Closed

Rename tasks #82

kmcdono2 opened this issue Feb 20, 2023 · 2 comments · Fixed by #95
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@kmcdono2
Copy link
Collaborator

Historically, we have called tasks by different names (slice vs patchify). We need to streamline this.

  1. Document different language in different parts of repo/docs
  2. Document changes to date
  3. Propose changes
@kmcdono2 kmcdono2 added the documentation Improvements or additions to documentation label Feb 20, 2023
@rwood-97
Copy link
Collaborator

Things to think about:

  • Set up of code/ sub-packages/ modules etc
  • Set up of docs
  • Paper

Names to think about:

  1. Download - I personally think this makes as the download sub-package is used to download files from remote/cloud storage to local PC. Works for both docs and package set-up
    a. TileServer (class) - I think this is confusing and gives v little info of what its for, following Andy's suggestion (may be good to rename TileServer class to make more intuitive #66) we could rename to TileServerClient?
  2. Loader (subpackage) - This subpackage is used to load local files into MapReader as mapImages object and contains loader and images modules. I think loader makes sense as a name for the overall subpackage but should maybe be load vs loader though to align with the other language used.
    a. slice (e.g slicer, sliceAll, etc.) - I think could be renamed to patchify/patch/etc (Rename all 'slice' functions/methods to 'patchify' to align with documentation/streamline vocab #70) Something to think about here is that paper uses the wording 'slice into patches'. Currently slicer is set up as a whole separate subpackage but only used within the loader subpackage so I think should be part of this subpackage/task (as separate module).
    b. parents and children - this phrasing is used throughout the loader/images modules and might be better to be parents and patches just to help everything line up? but equally might be confusing as moves away from the 'family tree' set up?
  3. Annotate - fine?
  4. Train - the train subpackage includes training, validating/testing and inference - is there an overall name that could be used instead? (learn?)

Part of #72 should be ensuring these line up too.

@kmcdono2
Copy link
Collaborator Author

kmcdono2 commented Mar 1, 2023

Thoughts on names per questions above.

  1. Download - great, let's keep
    1a. TileServer (class) - I like TileServerClient too
  2. Load vs loader - agree load is better as it's parallel
    2a. Patchify works
    2b. I'm ok changing children to patches. If people hate it, we can go back.
  3. Annotate - yes, fine
  4. Train - I like learn too. @andrewphilipsmith what do you think?

If we need to add a note about how terminology changed from what is in the paper, let's add a section to the documentation about that.

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

Successfully merging a pull request may close this issue.

2 participants