Skip to content

sarvex/jina-now

Β 
Β 

Repository files navigation

Jina NOW logo
One command to host them all. Bring your search case into the cloud in minutes.
Tell us what you think: Survey

Python 3.7 3.8 3.9 3.10 PyPI

Jina NOW logo

NOW gives the world access to multimodal neural search with just one command.

  • β›… Cloud: We handle deployment and maintenance.
  • 🐎 Fast and easy: Set up your search use case in minutes with minimal effort.
  • 🌈 Quality: You provide the labels, NOW fine-tunes the model.
  • ✨ Nocode: Non-technical people can deploy with ease.

Read how Jina NOW is production ready.

Install

pip install jina-now

If you need sudo to run Docker, use sudo to install and use Jina NOW as well.

Jina NOW is only available on Linux and macOS.

Mac M1

For the M1 we recommend using a Conda environment. In a new Conda environment:

  1. Run conda install grpcio tokenizers protobuf
  2. Run pip install jina-now.

Quick start

jina now start

1. Choose your data source.

NOW supports various formats for uploading your dataset to your search application. Please see the guide to loading your data for the full details on this step.

You may either choose a demo dataset hosted by NOW, or use your own custom dataset, to build an application. NOW can support your custom data in the form of a DocumentArray, as a path to a local folder, or S3 bucket.

? How do you want to provide input? (format: https://docarray.jina.ai/)  (Use arrow keys)
 ❯ Demo dataset
   DocumentArray name (recommended)
   Local folder
   S3 bucket
   - Elasticsearch (will be available in upcoming versions)

You can choose a demo dataset to get started quickly. The demo datasets are hosted by NOW which can be easily used to build a search application. There is a large variety of datasets, including images, text, and audio.

If you would like to use your own custom data, you can choose DocumentArray name in the CLI dialog. You will be asked to provide the DocumentArray ID (or name) or URL of your dataset.

? Please enter your DocumentArray name:

You can also choose the local folder option to upload your data, in which case NOW asks for the path to the folder containing your data:

? Please enter the path to the local folder:

Perhaps your data is stored in an S3 bucket, which is an option NOW also supports. In this case, NOW asks for the URI to the S3 bucket, as well as the credentials and region thereof.

? Please enter the S3 URI to the folder:
? Please enter the AWS access key ID:
? Please enter the AWS secret access key:
? Please enter the AWS region:

A final step in loading your data is to choose the fields of your data that you would like to use for search and filter respectively. You can choose from the fields that are available in your dataset.

2. Follow the links. After NOW finishes processing, you'll see two links:

  • The Swagger UI is useful for frontend integration.
  • The "playground" lets you run example queries and experiment with your search use case.
πŸš€ Deploy playground and BFF

BFF docs are accessible at:
http://localhost:30090/api/docs

Playground is accessible at:
http://localhost:30080/?host=gateway&search_field=image&data=best-artworks&port=8080

Example of the playground.

Screenshot 2022-05-26 at 16 36 49

Example of the Swagger UI.

Screenshot 2022-05-26 at 16 36 06

More information on using Jina NOW CLI and API

Supported modalities (more coming soon)

  • πŸ“ Text
  • 🏞 Image
  • πŸ₯ Music
  • πŸŽ₯ Video (for GIFs)
  • 🧊 3D Mesh (coming soon)

Example datasets

πŸ‘• Fashion image
☒️ Chest X-Ray
πŸ’° NFT - bored apes
πŸ–Ό Art image
πŸš— Cars image
🏞 Street view image
πŸ¦† Birds image

About

🧞 No-code tool for creating a neural search solution in minutes

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 98.4%
  • Shell 1.1%
  • Other 0.5%