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

Commit for documentation update for meta annotation #16

Merged
merged 6 commits into from
Aug 15, 2024

Conversation

shubham-s-agarwal
Copy link
Collaborator

Documentation update for meta annotation training to include training for bert and 2 phase learning.

Documentation update for meta annotation training to include training for bert and 2 phase learning
@mart-r
Copy link
Collaborator

mart-r commented Aug 13, 2024

Regarding meta_annotation_training.ipynb:

  • Is it just BERT or just LSTM MetaCATs? Would a mixture also work? Or does it simply not make a lot of sense? Maybe document that little bit - i.e the user should run 1 of the 2 code blocks, and not both of them; and potentially how a user could know whether the MetaCATs they've got are BERT or LSTM based.
  • Is there a reason the saving of the results was omitted?

Regarding meta_annotation_training_advanced.ipynb:

  • It feels more like a tutorial, or perhaps even a showcase. Though there is value in having both a tutorial as well as a script to be used in deployment. I just want to make sure this is how someone would use

@shubham-s-agarwal
Copy link
Collaborator Author

I've added a code block using which the user can see which model is used for that particular model pack.
I've also added the saving results back in.

Copy link
Collaborator

@mart-r mart-r 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

@shubham-s-agarwal shubham-s-agarwal merged commit cf0908e into main Aug 15, 2024
4 checks passed
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.

2 participants