Jina Hub

Jina Hub is an open-registry for hosting Jina executors via container images. It enables users to ship and exchange reusable component across various Jina search applications.

From Jina 0.4.10, Jina Hub is referred as a Git Submodule in jina-ai/jina.

Use Hub Image in Flow API

# my_image_tag is the the built image name

from jina.flow import Flow
with Flow().add(uses=my_image_tag):
    pass

Contribute to This Repository

Prerequisites

pip install "jina[hub]"

Install Docker.

Create a New Executor

git clone https://github.com/jina-ai/jina-hub.git
jina hub new --type pod

It will start a wizard in CLI to guide you create your first executor. The resulted file structure should look like the following:

- MyAwesomeExecutor/
    |
    |- Dockerfile
    |- manifest.yml
    |- README.md
    |- requirements.txt
    |- __init__.py
    |- tests/
        |- test_MyAwesomeExecutor.py
        |- __init__.py

Test an Executor Locally

jina hub build /MyAwesomeExecutor/

More Hub CLI usage can be found via jina hub build --help

Work with Your Own Repository

1. Create a new repository
2. pip install "jina[hub]" && jina hub new --type pod

git checkout -b feat-new-executor
git add .
git commit -m "feat: add new executor"
git push

4. Add the Hub Updater and Hub Builder Github Actions to the Github workflow of your hub-type repo.
5. Make a Pull Request on feat-new-executor -> master

References

Schema of manifest.yml

manifest.yml must exist if you want to publish your Pod image to Jina Hub.

manifest.yml annotates your image so that it can be managed by Jina Hub. To get better appealing on Jina Hub, you should carefully set manifest.yml to the correct values.

Key	Description	Default
manifest_version	The version of the manifest protocol	1
type	The type of the image	Required
kind	The kind of the executor	Required
name	Human-readable title of the image (must match with ^[a-zA-Z_$][a-zA-Z_\s\-$0-9]{3,30}$)	Required
description	Human-readable description of the software packaged in the image	Required
author	Contact details of the people or organization responsible for the image (string)	Jina AI Dev-Team ([email protected])
url	URL to find more information on the image (string)	https://jina.ai
documentation	URL to get documentation on the image (string)	https://docs.jina.ai
version	Version of the image, it should be Semantic versioning-compatible	0.0.0
vendor	The name of the distributing entity, organization or individual (string)	Jina AI Limited
license	License under which contained software is distributed, it should be in this list	apache-2.0
avatar	A picture that personalizes and distinguishes your image	None
platform	A list of CPU architectures that your image built on, each item should be in this list	[linux/amd64]
update	The update policy of the image, see the table below for details	nightly
keywords	A list of strings help user to filter and locate your package	None

Contributing

We welcome all kinds of contributions from the open-source community, individuals and partners. Without your active involvement, Jina won't be successful.

Please first read the contributing guidelines before the submission.

License

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

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