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 Annotation.audio_path attribute to notated_path #148

Closed
NickleDave opened this issue Mar 28, 2022 · 2 comments · Fixed by #169
Closed

rename Annotation.audio_path attribute to notated_path #148

NickleDave opened this issue Mar 28, 2022 · 2 comments · Fixed by #169
Assignees

Comments

@NickleDave
Copy link
Collaborator

NickleDave commented Mar 28, 2022

as discussed in #120 #58

  • rename to source_path
    • I kind of hate this name but I can't think of something more succinct and general
    • "source" is supposed to mean "the thing that is annotated"
    • another issue is that vak may rely on audio_path existing -- need to check this
  • add spect_path
    • this is more intuitive naming
    • it actually could be useful to have both spect_path and audio_path attributes
    • but then this starts to make crowsettas job to be a dataset tracker, since for some reason it now knows there are both spectrograms and audio files; that's actually not what we want
    • another option would be to add a post_init that requires one of the two, but not both, to be declared, i.e. either audio_path or spect_path
    • but then this makes the job of generic-seq more complicated; does it track audio_path or spect_path? or both?
@NickleDave NickleDave self-assigned this Mar 28, 2022
@NickleDave
Copy link
Collaborator Author

thought about the slightly cutesy notated_path

🤔

class Annotation
    annot_path
    notated_path

notated is not a word, or at least doesn't mean what annotated does.
But annot is not a word either.
At least it's more specific than "source" and avoids dealing with having multiple optional attributes

@NickleDave NickleDave changed the title rename Annotation.audio_path attribute to source_path, or add spect_path attribute rename Annotation.audio_path attribute to notated_path Apr 11, 2022
@NickleDave
Copy link
Collaborator Author

changed the issue name to reflect that

NickleDave added a commit that referenced this issue May 14, 2022
- Rename attribute
- Use 'Annotation.notated_path' in all formats;
  keep `audio_path` attribute for formats
  but convert to `notated_path` inside `to_annot` method
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 a pull request may close this issue.

1 participant