An open-registry for hosting Jina executors via container images
Jina's one-stop registry for hosting Pods and enabling easy neural search on the cloud
Docs • Examples • Contribute • Jobs • Website • Slack
# my_image_tag is the built image name
from jina import Flow
with Flow().add(uses='docker://' + my_image_tag):
pass
pip install "jina[hub]"
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
├── config.yml
├── README.md
├── requirements.txt
├── __init__.py
└── tests/
├── test_MyAwesomeExecutor.py
└── __init__.py
Link to the documentation for creating a containerized pod is here.
jina hub new --type app
It will start a wizard in CLI to guide you create your app.
Build your Docker image using our naming conventions:
jina hub build -t jinahub/type.kind.jina-image-name:image_version-jina_version <your_folder>
Push to Jina Hub:
jina hub login
, then copy/paste the token into GitHub to verify your account
jina hub push jinahub/type.kind.jina-image-name:image-jina_version
py_modules
to import multiple filesBy default, jina hub new --pod
creates a Python module structure and guides you to write MyAwesomeExecutor
class into __init__.py
. If you have some other files that need to be imported for MyAwesomeExecutor
, say helper.py
, you can change metas.pymodules
in config.yml
to import those files. Note, you have to write the dependencies in reverse order. That is, if __init__.py
depends on A.py
, which again depends on B.py
, then you need to write:
!MyAwesomeExecutor
with:
...
metas:
py_modules:
- B.py
- A.py
- __init__.py
This is also a valid structure, it works but not recommended:
- MyAwesomeExecutor/
|
|- Dockerfile
|- manifest.yml
|- README.md
|- requirements.txt
|- MyAwesomeExecutor.py
|- helper.py
|- config.yml
|- metas.py_modules
|- helper.py
|- MyAwesomeExecutor.py
Please note that:
MyAwesomeExecutor
directory is not a python module, as it lacks __init__.py
under the root;foo.py
, you must to use from jinahub.foo import bar
, where jinahub
is the common namespace for all external modules;config.yml:metas.py_modules
, helper.py
needs to be put before MyAwesomeExecutor.py
.jina hub build /MyAwesomeExecutor/
More Hub CLI usage can be found via jina hub build --help
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
feat-new-executor -> master
manifest.yml
Schemamanifest.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] |
keywords |
A list of strings help user to filter and locate your package | None |
All apps and executors should follow the naming convention:
jinahub/type.kind.jina_image_name:image_version-jina_version
For example:
jinahub/pod.encoder.transformertfencoder:0.0.16-0.9.33
Text | Meaning |
---|---|
jinahub/ |
Push to jinahub Docker repo |
app |
Type |
encoder |
Kind |
transformertfencoder |
Pod name |
0.0.16 |
Pod version |
0.9.33 |
Jina version |
From Jina 0.4.10 onwards, Jina Hub is referred as a Git Submodule in jina-ai/jina
.
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.
#JinaSearch
As part of our open governance model, we host Jina's Engineering All Hands in public. This Zoom meeting recurs monthly on the second Tuesday of each month, at 14:00-15:30 (CET). Everyone can join in via the following calendar invite.
The meeting will also be live-streamed and later published to our YouTube channel.
Jina is an open-source project. We are hiring full-stack developers, evangelists, and PMs to build the next neural search ecosystem in open source.
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.