Publish Executor

If you want to share your Executors to other persons or colleges, you can push your local Executor to the Hub.

There are two types of sharing:

  • Public (default): anyone can use the public executors without any restriction.

  • Private: only people that has the secret can use the private executors.

First publish

jina hub push [--public/--private] <path_to_executor_folder>
../../../_images/hub-push.gif

It will return UUID & SECRET, which you will need when using (if private) or update the Executor later. Please keep them carefully.

You can then visit the Hub portal, click on the “Recent” tab and see your published Executor.

Note

If no --public or --private visibility option is provided, then it is public by default.

Important

Anyone can use any public Executor, but to use a private Executor one must know SECRET.

Update published Executors

To override or update a published Executor, you must have both UUID and SECRET.

jina hub push [--public/--private] --force <UUID> --secret <SECRET> <path_to_executor_folder>

Tagging Executor

Tagging can be useful for versioning Executors; or differing Executors by their architectures (e.g. gpu, cpu).

jina hub push <path_to_executor_folder> -t TAG1 -t TAG2

You can specify -t or --tags parameters to tag one Executor.

If there is no -t parameter provided, the default tag is latest. And if you provide -t parameters, and you still want to have latest tag, you must write it as one -t parameter.

jina hub push .                     # Result in one tag: latest
jina hub push . -t v1.0.0           # Result in one tag: v1.0.0
jina hub push . -t v1.0.0 -t latest # Result in two tags: v1.0.0, latest

If you want to create a new tag for an existing Executor, you can also add the -t option here:

jina hub push [--public/--private] --force <UUID> --secret <SECRET> -t TAG <path_to_executor_folder>