Hide navigation sidebar

Hide table of contents sidebar

Learn more about Pet Breed Classification on May 10th at 18:00 CET

Toggle site navigation sidebar

Jina 3.4.0 documentation

Toggle table of contents sidebar

Get started

What is Neural Search?
What is Jina?
Comparing to Alternatives
Install
Toggle child pages in navigation
- Jina on Windows
- Troubleshooting
Create a New Project
Run Quick Demos
Toggle child pages in navigation

User Guides

Architecture Overview
Executor
Toggle child pages in navigation
- Executor API
- Executors inside a Flow
- Executor File Structure
- Share Executors via Jina Hub
  Toggle child pages in navigation
- Dockerize your Executor
- Monitor Executor with Custom Metrics
Flow
Toggle child pages in navigation
Clean & Efficient Code

How-to

Deploy
Toggle child pages in navigation
Executor
Toggle child pages in navigation

Developer Reference

Migration to Jina 3
Python API
Toggle child pages in navigation
- jina package
  Toggle child pages in navigation
  - jina.clients package
    Toggle child pages in navigation
    - jina.clients.base package
      Toggle child pages in navigation
    - jina.clients.request package
      Toggle child pages in navigation
      - jina.clients.request.asyncio module
      - jina.clients.request.helper module
    - jina.clients.grpc module
    - jina.clients.helper module
    - jina.clients.http module
    - jina.clients.mixin module
    - jina.clients.websocket module
  - jina.helloworld package
    Toggle child pages in navigation
    - jina.helloworld.chatbot package
      Toggle child pages in navigation
      - jina.helloworld.chatbot.app module
      - jina.helloworld.chatbot.my_executors module
    - jina.helloworld.fashion package
      Toggle child pages in navigation
    - jina.helloworld.multimodal package
      Toggle child pages in navigation
      - jina.helloworld.multimodal.app module
      - jina.helloworld.multimodal.my_executors module
    - jina.helloworld.fork module
  - jina.hubble package
    Toggle child pages in navigation
  - jina.jaml package
    Toggle child pages in navigation
    - jina.jaml.parsers package
      Toggle child pages in navigation
      - jina.jaml.parsers.default package
        Toggle child pages in navigation
        
        jina.jaml.parsers.default.v1 module
      - jina.jaml.parsers.executor package
        Toggle child pages in navigation
        
        jina.jaml.parsers.executor.legacy module
      - jina.jaml.parsers.flow package
        Toggle child pages in navigation
        
        jina.jaml.parsers.flow.v1 module
      - jina.jaml.parsers.base module
    - jina.jaml.helper module
  - jina.logging package
    Toggle child pages in navigation
  - jina.orchestrate package
    Toggle child pages in navigation
    - jina.orchestrate.deployments package
      Toggle child pages in navigation
      - jina.orchestrate.deployments.config package
        Toggle child pages in navigation
        
        jina.orchestrate.deployments.config.k8slib package
        Toggle child pages in navigation
        
        jina.orchestrate.deployments.config.k8slib.kubernetes_deployment module
        
        jina.orchestrate.deployments.config.k8slib.kubernetes_tools module
        
        jina.orchestrate.deployments.config.docker_compose module
        
        jina.orchestrate.deployments.config.helper module
        
        jina.orchestrate.deployments.config.k8s module
    - jina.orchestrate.flow package
      Toggle child pages in navigation
    - jina.orchestrate.pods package
      Toggle child pages in navigation
    - jina.orchestrate.helper module
  - jina.parsers package
    Toggle child pages in navigation
    - jina.parsers.hubble package
      Toggle child pages in navigation
    - jina.parsers.orchestrate package
      Toggle child pages in navigation
    - jina.parsers.base module
    - jina.parsers.client module
    - jina.parsers.create module
    - jina.parsers.deprecated module
    - jina.parsers.export_api module
    - jina.parsers.flow module
    - jina.parsers.helloworld module
    - jina.parsers.helper module
    - jina.parsers.ping module
  - jina.proto package
    Toggle child pages in navigation
  - jina.schemas package
    Toggle child pages in navigation
  - jina.serve package
    Toggle child pages in navigation
    - jina.serve.executors package
      Toggle child pages in navigation
      - jina.serve.executors.decorators module
      - jina.serve.executors.metas module
    - jina.serve.runtimes package
      Toggle child pages in navigation
      - jina.serve.runtimes.gateway package
        Toggle child pages in navigation
        
        jina.serve.runtimes.gateway.graph package
        Toggle child pages in navigation
        
        jina.serve.runtimes.gateway.graph.topology_graph module
        
        jina.serve.runtimes.gateway.grpc package
        
        jina.serve.runtimes.gateway.http package
        Toggle child pages in navigation
        
        jina.serve.runtimes.gateway.http.app module
        
        jina.serve.runtimes.gateway.http.models module
        
        jina.serve.runtimes.gateway.websocket package
        Toggle child pages in navigation
        
        jina.serve.runtimes.gateway.websocket.app module
        
        jina.serve.runtimes.gateway.request_handling module
      - jina.serve.runtimes.head package
      - jina.serve.runtimes.request_handlers package
        Toggle child pages in navigation
        
        jina.serve.runtimes.request_handlers.data_request_handler module
      - jina.serve.runtimes.worker package
      - jina.serve.runtimes.asyncio module
      - jina.serve.runtimes.base module
      - jina.serve.runtimes.monitoring module
    - jina.serve.stream package
      Toggle child pages in navigation
      - jina.serve.stream.helper module
    - jina.serve.networking module
  - jina.types package
    Toggle child pages in navigation
    - jina.types.request package
      Toggle child pages in navigation
      - jina.types.request.control module
      - jina.types.request.data module
    - jina.types.mixin module
  - jina.checker module
  - jina.enums module
  - jina.excepts module
  - jina.helper module
  - jina.importer module
- cli package
  Toggle child pages in navigation
Command-Line Interface
Protocol Documentation
Jina 2 Documentation

Ecosystem

Jina
Jina Hub
Finetuner
DocArray
CLIP-as-service
JCloud

Toggle table of contents sidebar

cli.autocomplete module#

cli.export module

Copyright © Jina AI Limited. All rights reserved. Last updated on Oct 01, 2024.

You can ask questions about our docs. Try:: Does Jina support Kubernetes?; What are the basic concepts in Jina?; How to share my Executor?