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

Better batch documentation #127

Open
1 task done
ju-bezdek opened this issue May 17, 2022 · 1 comment
Open
1 task done

Better batch documentation #127

ju-bezdek opened this issue May 17, 2022 · 1 comment
Labels
discussion/suggestion needs review Needs someone to review (eg whether it is still relevant)

Comments

@ju-bezdek
Copy link

Code of Conduct

What part of document/web-page on weaviate.io is affected?

What part of document/web-page on weaviate.io is affected?
https://weaviate.io/developers/weaviate/current/restful-api-references/batch.html

a) mention how references in single batch are handled. Currently it raises error (and @etiennedi) said that it's not a bug
(I've also created a feature request weaviate/weaviate#1951)

b) better explanation how batch works

c) add a link to Jupyter notebook with more examples and explanation https://github.com/semi-technologies/weaviate-examples/blob/main/getting-started-with-python-client-colab/Getting_Started_With_Weaviate_Python_Client.ipynb
... however even this notebook don't really tackles error handling in batch, and contains lot's of topics unrelated to batch processing, so maybe providing more complete examples to docs would be preferable

I'd strongly consider also merging the page with https://weaviate.io/developers/weaviate/current/tutorials/how-to-import-data.html

... I seems to be discusing the same concepts, there is strong overlap but, however both pages adds some more information to the topic...

Minimal effort solution would be also adding link to each other.

Additional comments?

No response

@etiennedi
Copy link
Member

Thanks for the feedback, also looping in @sebawita for visibility of the above.

@databyjp databyjp added discussion/suggestion needs review Needs someone to review (eg whether it is still relevant) labels Apr 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion/suggestion needs review Needs someone to review (eg whether it is still relevant)
Projects
None yet
Development

No branches or pull requests

3 participants