To create your Hub Executor, you just need to run:
jina hub new
For the basic configuration, you will be asked for two things: The Executor’s name and where it should be saved. A more advanced configuration is optional but rarely necessary.
After running the command, a project with the following structure will be generated:
MyExecutor/ ├── Dockerfile # Advanced configuration will generate this file ├── manifest.yml ├── config.yml ├── README.md ├── requirements.txt └── executor.py
manifest.ymlshould contain the Executor’s annotations for getting better exposure on Jina Hub.
config.ymlis the Executor’s configuration file, where you can define init arguments using with keyword.
requirements.txtdescribes the Executor’s Python dependencies.
executor.pyshould contain your Executor’s main logic.
README.mdshould describe how to use your Executor.
manifest.yml is optional.
manifest.yml annotates your image so that it can be better managed by the Hub portal. To get better exposure on Jina Hub, you may want to
manifest.yml to the correct values:
||The version of the manifest protocol||
||Human-readable title of the Executor||None|
||Human-readable description of the Executor||None|
||URL to find more information about the Executor, normally the GitHub repo URL||None|
||A list of strings to help users filter and locate your package||None|