Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jina-ai/examples
Jina examples and demos to help you get started
https://github.com/jina-ai/examples
deep-learning examples jina neural-search nlp onboarding python semantic-search tutorials
Last synced: about 1 month ago
JSON representation
Jina examples and demos to help you get started
- Host: GitHub
- URL: https://github.com/jina-ai/examples
- Owner: jina-ai
- License: apache-2.0
- Archived: true
- Created: 2020-02-17T07:45:56.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-11-01T07:58:19.000Z (over 2 years ago)
- Last Synced: 2024-02-19T19:48:07.859Z (5 months ago)
- Topics: deep-learning, examples, jina, neural-search, nlp, onboarding, python, semantic-search, tutorials
- Language: Python
- Homepage: https://docs.jina.ai
- Size: 189 MB
- Stars: 454
- Watchers: 37
- Forks: 145
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- my-awesome-stars - examples - ai | 455 | (Python)
- awesome-stars - jina-ai/examples - Jina examples and demos to help you get started (python)
README
# [PLEASE CHECK OUR DOC WEBSITE FOR MORE COMPREHENSIVE EXAMPLES.](https://docs.jina.ai)
# Examples for Jina
**Table of Contents**
- [Adding Tests for Examples](#adding-tests-for-examples)
- [Community](#community)
- [License](#license)
These examples showcase Jina in action and provide sample code for you to work from.
We suggest you read the following to get an overview of what Jina is and how it works:
- [What is neural search?](https://github.com/jina-ai/jina/blob/master/.github/2.0/neural-search.md)
- [Get started](https://github.com/jina-ai/jina/#build-your-first-jina-app) - especially the cookbooks for Document, Executor and Flow
## 🐣 Simple Examples
📄
Semantic Wikipedia Search with Transformers and DistilBERT
Brand new to neural search? See a simple text-search example to understand how Jina works
📄
Search Lyrics with Transformers and PyTorch
Get a better understanding of chunks by searching a lyrics database. Now with shiny front-end!
📄
Find Similar Audio Clips
A simple example to show how to find similar audio clips using Jina
## 🚀 Advanced Examples
📄
Querying While Indexing in the Wikipedia Search Example
Support both querying and indexing simultaneously in our Wikipedia Search Example
🖼️📄
Cross Modal: Search images from captions and vice-versa
Use one modality (text) to search another (images)
## Community Examples
Want to add your own example? Please check our [guidelines](example-guidelines.md)!
🖼️📄
Meme Search - Text search / Image search / Front end
Search memes by caption or similar image.
📄
App Store Search
Use Transformers to search through a rich app store dataset with a responsive front-end
📄
Star Wars Question Answering System
Generate answers based on star wars descriptions from wookieepedia.
#### Legacy examples
📄
Financial Question Answering Search
Opinionated QA passage retrieval with BERT-based reranker
## 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](https://docs.pytest.org/en/stable/contents.html)
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 any of the examples in this repo.
- Try using the original example function by importing them to the test. Avoid any modifications to original Flow or logic.
- Use the [pytest fixture](https://docs.pytest.org/en/stable/fixture.html) `tmpdir` for temporary directory
## Community
- [Slack channel](http://slack.jina.ai) - a communication platform for developers to discuss Jina
- [LinkedIn](https://www.linkedin.com/company/jinaai/) - get to know Jina AI as a company and find job opportunities
- [](https://twitter.com/JinaAI_) - follow us and interact with us using hashtag `#JinaSearch`
- [Company](https://jina.ai) - 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](https://github.com/jina-ai/jina/blob/master/LICENSE) for the full license text.