Publish Executor#
If you want to share your Executor, you can push it to Jina Hub.
There are two types of sharing:
Public (default): Anyone can use public Executors without any restrictions.
Private: Only people that have the
secret
can use private Executors.
First publish#
jina hub push [--public/--private] <path_to_executor_folder>
It will return NAME
& SECRET
, which you will need to use (if the Executor is private) or update the Executor. 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
argument is provided, then it is public by default.
Important
Anyone can use public Executors, but to use a private Executor you must know its SECRET
.
Update published Executors#
To override or update a published Executor, you must have both NAME
and SECRET
.
jina hub push [--public/--private] --force-update <NAME> --secret <SECRET> <path_to_executor_folder>
Tagging an Executor#
Tagging can be useful for versioning Executors or differentiating them by their architecture (e.g. gpu
, cpu
).
jina hub push <path_to_executor_folder> -t TAG1 -t TAG2
You can specify -t
or --tags
parameter to tag an Executor.
If you don’t add the
-t
parameter, the default tag islatest
If you do add the
-t
parameter and you still want to have thelatest
tag, you must write it as another-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-update <NAME> --secret <SECRET> -t TAG <path_to_executor_folder>