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

align language used to describe task names within code and documentation #95

Merged
merged 29 commits into from
Apr 20, 2023

Conversation

rwood-97
Copy link
Collaborator

@rwood-97 rwood-97 commented Mar 1, 2023

Summary

As per #82 - Language used to describe the different 'tasks' performed by the mapreader package do not always align between code/documentation/MR paper. This PR focuses on renaming/aligning language used throughout MapReader to ensure ease of use.

Addresses #82

Describe your changes

  • rename loader (subpackage) to load
  • rename children to patches.
  • rename slice/slicer/etc to patch/patchify/etc. Fixes Rename all 'slice' functions/methods to 'patchify' to align with documentation/streamline vocab #70
  • rename TileServer (class) to TileServerClient Since discussion leading to Issue no#99 we may need further updates to this TileServer class so am leaving for now
  • rename train to learn NOTE: I have done this but may be better to split it into training and inference
  • Change default path_save for patches from 'test' to 'patches'

Checklist before assigning a reviewer (update as needed)

  • Self-review code
  • Ensure submission passes current tests

Reviewer checklist

Please add anything you want reviewers to specifically focus/comment on.

  • Everything looks ok?

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@rwood-97 rwood-97 self-assigned this Mar 3, 2023
@rwood-97 rwood-97 linked an issue Mar 23, 2023 that may be closed by this pull request
@andrewphilipsmith andrewphilipsmith removed a link to an issue Mar 23, 2023
@andrewphilipsmith andrewphilipsmith linked an issue Mar 23, 2023 that may be closed by this pull request
@rwood-97
Copy link
Collaborator Author

rwood-97 commented Mar 29, 2023

Will need to update worked_examples at some point - potentially these will be reworked a little before June so will leave for this PR.

  • Make issue re. updating worked_examples

@rwood-97 rwood-97 marked this pull request as ready for review March 29, 2023 12:44
@rwood-97
Copy link
Collaborator Author

@andrewphilipsmith Think this is good to go (as with the other PR you can ignore all of docs/source/api).

Copy link
Collaborator

@andrewphilipsmith andrewphilipsmith left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. Two tiny issues that can be each be dealt with either in the PR or raised as separate issues as you see fit.

only_keep_image_ids : list of str, optional
List of image IDs to keep in the metadata (default is an empty
list, ``[]``).
List of image IDs to keep in the metadata (default is an empty list, ``[]``).

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I realise that this change is only a formatting change in the docstring, but I'm not quite sure of the logic of this function.

  • I can't see if this is used anywhere. If it is only used as a helper function by users, then ideally, there should be an example in one of the notebooks.
  • If it's not used at all then it should be removed.

If it is used, then how does it handle edge cases? Eg

  • What happens if both remove_image_ids and only_keep_image_ids are empty? Does everything get removed or does everything get kept? Which takes precedence?
  • What happens if both lists contain the same IDs? Does an error/exception get raised to the user?

Either way, these questions should get moved to a separate issue, rather than trying to resolve them here.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Made this as an issue (#161).

rwood-97 and others added 2 commits April 20, 2023 08:13
remove typo (double underscore infront of _add_shape_id)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rename tasks Rename all 'slice' functions/methods to 'patchify' to align with documentation/streamline vocab
2 participants