haystack icon indicating copy to clipboard operation
haystack copied to clipboard

docs: extend tutorial14 about query classification

Open anakin87 opened this issue 2 years ago β€’ 5 comments

As stated in #2965, it would be good to include in Tutorial 14 a small section about new features of TransformersQueryClassifier:

  • using custom transformer models
  • using zero-shot-classification

Proposed Changes:

I added a small section on these features, similar to what has been done for the features already present. I'm not that good with documentation, so I'd beg the people involved (@agnieszka-m @TuanaCelik @mkkuemmel) to brutally make the necessary changes :smiley:

Checklist

anakin87 avatar Aug 09 '22 16:08 anakin87

Check out this pull request onΒ  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@agnieszka-m, looping you in here as I think you'd like to have a look at the language. @anakin87 I'll also put in a review πŸ™‚

TuanaCelik avatar Aug 09 '22 22:08 TuanaCelik

Overall I think this is great. I would have one suggestion though, as it's a tutorial, I think it might be useful to be a bit more explicit about the difference of zero-shot vs custom classification. The reader might not understand the difference in the current version. For example it starts off with how for custom, you can use a model from the hub. But then you see that you can also use one for zero-shot. The other thing is they might not understand the difference of you defining your own labels like 'cinema' and 'music' being any different to the other labels which are simply 'label1' etc.

All in all some more hand holding go well for a tutorial πŸ‘πŸ½

Thank you for the contribution!! πŸŽ‰

TuanaCelik avatar Aug 09 '22 23:08 TuanaCelik

Hi! Since my changes are mostly minor language corrections, would you like me to do them directly on your files or would you rather I add comments to the files? Whatever works best for you.

agnieszka-m avatar Aug 10 '22 06:08 agnieszka-m

@TuanaCelik I made some improvements. Please let me know WDYT... :smiley:

Hi! Since my changes are mostly minor language corrections, would you like me to do them directly on your files or would you rather I add comments to the files? Whatever works best for you.

@agnieszka-m for me it is the same...

anakin87 avatar Aug 10 '22 07:08 anakin87

When the notebook tutorial is acceptable, I will add the .py version as well.

anakin87 avatar Aug 10 '22 14:08 anakin87

I've made some minor fixes and added the .py tutorial. In the next few days, I won't be online :parasol_on_ground:, so feel free to make corrections (if needed) and take charge of this PR.

anakin87 avatar Aug 10 '22 21:08 anakin87

@anakin87 this is almost good to go. Only the tutorial script is missing. I'm pushing it over the finish line.

tstadel avatar Aug 11 '22 17:08 tstadel

@anakin87 unfortunately I don't have write access. Can you run the script yourself or grant me access?

tstadel avatar Aug 11 '22 17:08 tstadel

'Allow edits and access to secrets by maintainers' is already selected. What can I do to allow you?

anakin87 avatar Aug 11 '22 18:08 anakin87

'Allow edits and access to secrets by maintainers' is already selected. What can I do to allow you?

@anakin87 Ok, weird. To fix this quickly, can you grant me access individually maybe?

tstadel avatar Aug 12 '22 08:08 tstadel

I invited you to collaborate on my fork... Hope it helps...

anakin87 avatar Aug 12 '22 09:08 anakin87

@anakin87 Yes thanks! Now it's working.

tstadel avatar Aug 12 '22 12:08 tstadel