Examples for Jina

Table of Contents

• Adding Tests for Examples
• Community
• License

These examples showcase Jina in action and provide sample code for you to work from. We suggest you read Jina 101 and What is Neural Search? to get a conceptual overview.

❗If you'd like to run our examples on Windows, please follow this instruction.

To learn more about how to use Jina, please refer to our docs.

🐣 Simple Examples

🚀 Advanced Examples

Community Examples

Want to add your own example? Please check our guidelines!

Adding Tests for Examples

You are highly encouraged to add a test for your example so that we will be alerted if it breaks in the future:

1. Put your test data in the tests folder. The test data can be a few text sentences, images or audio samples
2. Create test_[your_example].py in the tests folder. Add your test cases to the tests file with meaningful asserts depending on example input and output
3. Run the test locally to confirm before pushing with pytest
4. Add your example folder name to the path variable in matrix of .github/worflows/ci.yml. This will trigger your example test on creating a pull request.

Testing Tips

• For reference, check out the tests folder from South Park example if your data is about text and object search example for images.
• Try using the original example function by importing them to the test. Avoid any modifications to original Flow or logic.
• Use the pytest fixture tmpdir for temporary directory

Community

• Slack channel - a communication platform for developers to discuss Jina
• LinkedIn - get to know Jina AI as a company and find job opportunities
• - follow us and interact with us using hashtag #JinaSearch
• Company - know more about our company, we are fully committed to open-source!

License

Copyright (c) 2021 Jina AI Limited. All rights reserved.

Jina is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.