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

Badges in the tutorials #125

Open
3 tasks
joein opened this issue Jun 6, 2022 · 5 comments
Open
3 tasks

Badges in the tutorials #125

joein opened this issue Jun 6, 2022 · 5 comments
Labels
documentation Improvements or additions to documentation

Comments

@joein
Copy link
Member

joein commented Jun 6, 2022

Add badges into the tutorials:

  • colab notebook
  • download notebook
  • view on github

Similar to torch tutorials

image

@joein joein added the documentation Improvements or additions to documentation label Jun 6, 2022
@joein joein changed the title Badges in tutorial Badges in the tutorials Jun 6, 2022
@monatis
Copy link
Contributor

monatis commented Jun 16, 2022

Our tutorials have some omitted code parts, and notebooks are not good for restoring a SimilarityModel after saving at the moment until #38. So I doubt if this will be helpful.

@generall
Copy link
Member

Will try to save as ONNX, it should work even in jupyter

@joein
Copy link
Member Author

joein commented Jun 16, 2022

Notebooks and colab provide a way to launch code with minimal efforts and can help us make the first acquaintance with the framework easier. With notebooks it is possible to change some code in the tutorial instantly, not just staring at it on the tutorial page.

We can add hidden from tutorials pages code to notebooks (it is about tutorials which have complete examples, like nlp and cv).

If we can't fix saving right now, we have some ugly fallback which should work - use directives like %% writefile encoder.py or just avoid saving in notebooks.

@monatis
Copy link
Contributor

monatis commented Jun 16, 2022

it is about tutorials which have complete examples, like nlp and cv

Yes it might be relevant for these two tutorials after some modifications.

@helios2003
Copy link

Hello, Ankit here. I am really interested in contributing to Qdrant and this issue struck me as really interesting. Can I be assigned this issue ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

4 participants