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 'unlabeled_label' -> 'unlabeled_class'; define as constant and use constant for default args #408

Closed
3 tasks
Tracked by #614
NickleDave opened this issue Nov 28, 2021 · 2 comments
Assignees
Labels
ENH: enhancement enhancement; new feature or request

Comments

@NickleDave
Copy link
Collaborator

NickleDave commented Nov 28, 2021

because it's confusing to talk about "labeled as unlabeled", and by analogy with the "background" class used in object detection

  • define a constant in vak.constants like BACKGROUND_CLASS_NAME = 'background'
  • use that constant in all the functions that have it as a default, e.g. vak.labels.multi_char_labels has a skip default that currently is ('unlabeled',), rewrite as -> (constants.BACKGROUND_CLASS_NAME,)
  • also use in vak.labelset itself when we make the labelmap
@NickleDave NickleDave added the ENH: enhancement enhancement; new feature or request label Nov 28, 2021
@NickleDave NickleDave self-assigned this Nov 28, 2021
@NickleDave NickleDave changed the title rename 'unlabeled' to 'background' rename 'unlabeled_label' -> 'unlabeled_class'; define as constant and use constant for default args Feb 24, 2023
@NickleDave
Copy link
Collaborator Author

Thinking about this more.
The thing is that "unlabeled" is the more precise name.
When we use it, it's because we specifically care about segments left unlabeled when annotation a sequence of segments.

But I agree with myself that

  • unlabeled_label is a confusing variable name, should be renamed unlabeled_class
  • it would be better to have a constant and use that throughout the code base instead of having to find

@NickleDave
Copy link
Collaborator Author

Done in #755. Note I went with background_label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ENH: enhancement enhancement; new feature or request
Projects
None yet
Development

No branches or pull requests

1 participant