Use Hub Executor

Tip

Starting from Jina 2.2.5, you can directly use a Hub Executor as a native Python object without putting it into a Flow.

We provide three ways of using Hub Executors in your project. Each has its own use case and benefit.

Use as-is

You can use a Hub Executor as-is via Executor.from_hub():

  1. from jina import Executor, DocumentArray, Document
  3. exec = Executor.from_hub('jinahub://DummyHubExecutor')
  4. da = DocumentArray([Document()])
  5. exec.foo(da)
  6. assert da.texts == ['hello']

The Hub Executor will be pulled to your local machine and run as a native Python object. You can use a line-debugger to step in/out exec object, set breakpoints, and observe how it behaves. You can directly feed in a DocumentArray. After you build some confidence in that Executor, you can move to the next step: Using it as a part of your Flow.

Caution

Not all executors on the Hub can be directly run in this way, some require extra dependencies. In that case you can add .from_hub(..., install_requirements=True) to install the requirements automatically. Be careful, these dependencies may not be compatible with your local packages and may override your local development environment.

Tip

Hub Executors are cached locally on the first pull. Afterwards, they will not be updated.

To keep up-to-date with upstream, use .from_hub(..., force_update=True).

Use in a Flow: via Docker

Use prebuilt images from Hub in your Python code:

  1. from jina import Flow
  3. # SECRET must be provided for private Executor
  4. f = Flow().add(uses='jinahub+docker://<UUID>[:<SECRET>][/<TAG>]')

If you do not provide a /<TAG>, it defaults to /latest, which means using the latest tag.

Important

To use private a Executor, you must provide the SECRET. It is generated after jina hub push.

../../../_images/secret.png

Attention

If you are a Mac user, please use host.docker.internal as your URL when you want to connect a local port from an Executor Docker container.

For example: PostgreSQLStorage will connect PostgreSQL server which was started locally. Then you must use it with:

  1. from jina import Flow, Document
  3. f = Flow().add(uses='jinahub+docker://PostgreSQLStorage', 
  4.                uses_with={'hostname': 'host.docker.internal'})
  5. with f:
  6.     resp = f.post(on='/index', inputs=Document(), return_results=True)
  7.     print(f'{resp}')

Use in a Flow: via source code

Use the source code from Hubble in your Python code:

  1. from jina import Flow
  3. f = Flow().add(uses='jinahub://<UUID>[:<SECRET>][/<TAG>]')

Override default parameters

The default parameters of the published Executor may not be ideal for your use case. You can override any of these by passing uses_with and uses_metas as parameters.

  1. from jina import Flow
  3. f = Flow().add(uses='jinahub://<UUID>[:<SECRET>][/<TAG>]', 
  4.                uses_with={'param1': 'new_value'},
  5.                uses_metas={'name': 'new_name'})

Pulling without using

You can also use jina hub CLI to pull an Executor without actually using it in the Flow.

Pull the Docker image

  1. jina hub pull jinahub+docker://<UUID>[:<SECRET>][/<TAG>]

You can find the Executor by running docker images. You can also indicate which version of the Executor you want to use by naming the /<TAG>.

  1. jina hub pull jinahub+docker://DummyExecutor/v1.0.0

Pull the source code

  1. jina hub pull jinahub://<UUID>[:<SECRET>][/<TAG>]

The source code of the Executor will be stored at ~/.jina/hub-packages.