diff --git a/README.md b/README.md index 820ae907..c3e9e69f 100644 --- a/README.md +++ b/README.md @@ -8,26 +8,33 @@ [![License MIT](https://img.shields.io/badge/License-MIT-blue)](https://github.com/instill-ai/vdp/blob/main/protocol/LICENSE) [![License ELv2](https://img.shields.io/badge/License-ELv2%20-blue)](https://github.com/instill-ai/vdp/blob/main/LICENSE) +
+ +
+ Build, test and share your pipelines - No code required! +
-๐Ÿ’ง **Instill VDP (Versatile Dataย Pipeline)** is a source available unstructured data ETL tool to streamline the end-to-end unstructured data processing pipeline. +
-โ˜๏ธ **Instill Cloud** offers fully managed **Instill VDP**. Please [sign up](https://console.instill.tech) to try out for free. +๐Ÿ’ง **Instill VDP (Versatile Dataย Pipeline)** is a source-available tool, designed to streamline your data processing pipelines from inception to completion. If your goal is to develop versatile AI features using Large Language Models (LLM), Generative AI, Vision, or Audio models, Instill VDP empowers you to: -## Highlights - -- ๐Ÿงฌ **[The backbone for all your AI needs](https://www.instill.tech/docs/core-concepts/pipeline)** - production-ready AI-first applications built with LLM, Diffusion Models and more - -- ๐Ÿš€ **[The fastest way to build unstructured data pipelines](https://www.instill.tech/docs/core-concepts/pipeline)** - building a pipeline is like assembling LEGO blocks - -- โšก๏ธ **[High-performing backends](https://www.instill.tech/docs/prepare-models/overview)** implemented in Go - -- ๐Ÿ”Œ **[Pre-built miscellaneous connectors](https://www.instill.tech/docs/core-concepts/connector)** for extensive data and AI access +- Effortlessly **connect** to your unstructured data +- **Build** pipelines to enable diverse AI functionalities in your applications +- Visually **test** pipelines with a single click, viewing output at each stage +- Easily **share** your pipelines to showcase your work -- ๐Ÿชข **[Build pipelines for diverse scenarios](https://www.instill.tech/docs/core-concepts/pipeline#mode)** - **SYNC** mode for real-time inference, and **ASYNC** or **PULL/PUSH** mode for on-demand workload +**โ˜๏ธ [Instill Cloud](https://console.instill.tech)** is a fully-managed public cloud service that grants you access to all the fantastic features of Instill VDP, without the hassle of managing infrastructure. -- ๐Ÿง **[Scalable API-first platform](https://www.instill.tech/docs/start-here/faq#tech)** - seamless integration to modern data stack at any scale +## Highlights -- ๐Ÿค  **[Built for every AI and Data practitioner](https://www.instill.tech/docs/start-here/faq#essentials)** - The no-/low-code interface helps take off your AI Researcher, AI Engineer, Data Engineer, Data Scientist, designer, marketer and content creator hat and *put on the all-rounder hat* to deliver more with VDP +- ๐Ÿš€ Accelerate AI applications by building end-to-end AI-powered pipelines for unstructured data up to 10 times faster +- ๐Ÿ”Œ Utilize pre-built connectors to access data from various sources, powerful AI models, and third-party tools +- ๐ŸŒŸ Benefit from a no-code drag-and-drop pipeline builder, enabling quick and customizable application development +- ๐Ÿชข Choose between real-time inference (SYNC) and on-demand workload (ASYNC) processing modes +- ๐Ÿง Enjoy a scalable API-first microservice design, offering an excellent developer experience +- โšก๏ธ Leverage high-performing backends implemented in Go +- ๐Ÿ“Š Gain visibility into pipeline performance through a detailed dashboard +- ๐Ÿค  Access no-/low-code interfaces, making VDP suitable for every AI and data practitioner ## Prerequisites @@ -35,7 +42,10 @@ - **Docker and Docker Compose** - VDP uses Docker Compose (specifically, `Compose V2` and `Compose specification`) to run all services at local. Please install the latest stable [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) before using VDP. -## Quick start +## Quick Start + +> **Note** +> Code in the main branch tracks under-development progress towards the next release and may not work as expected. If you are looking for a stable alpha version, please use [latest release](https://github.com/instill-ai/vdp/releases). Execute the following commands to start pre-built images with all the dependencies: @@ -66,28 +76,41 @@ To shut down all running services: $ make down ``` -> **Note** -> Code in the main branch tracks under-development progress towards the next release and may not work as expected. If you are looking for a stable alpha version, please use [latest release](https://github.com/instill-ai/vdp/releases). +Explore our [documentation](https://www.instill.tech/docs/vdp/deployment/overview) to discover all available deployment options. -## Documentation +## Dive into the Projects + +Instill VDP stands as a crucial project within our **[Instill Core](https://github.com/instill-ai#instill-core)** stack. It provides an open-source AI infrastructure tailored for unstructured data, enabling versatile AI application development. Within this ecosystem, delve into source-available projects that enable you to construct flexible AI pipelines, enhancing your data processing abilities and converting raw data into actionable insights. -๐Ÿ“” **Documentation** +- ๐Ÿ’ง [Instill VDP](https://github.com/instill-ai/vdp): Streamline the unstructured data journey for AI applications +- โš—๏ธ [Instill Model](https://github.com/instill-ai/model): Transform your applications with AI models +- ๐Ÿ—ฟ [Instill Base](https://github.com/instill-ai/base): Essential Services for VDP and Model - Please check out the [documentation](https://www.instill.tech/docs?utm_source=github&utm_medium=banner&utm_campaign=vdp_readme) website. +## No-/Low-code Access & Support -๐Ÿ“˜ **API Reference** +To dive into Instill Core and Instill Cloud, we provide: -The gRPC protocols in [protobufs](https://github.com/instill-ai/protobufs) provide the single source of truth for the VDP APIs. The genuine protobuf documentation can be found in our [Buf Scheme Registry (BSR)](https://buf.build/instill-ai/protobufs). +- โœจ [Console](https://github.com/instill-ai/console) for non-developers, empowering them to dive into AI applications and process unstructured data without any coding. +- ๐Ÿงฐ CLI and SDKs for developers to seamlessly integrate with their existing data stack in minutes. + - [Instill CLI](https://github.com/instill-ai/cli) + - [Python SDK](https://github.com/instill-ai/python-sdk) + - [TypeScript SDK](https://github.com/instill-ai/typescript-sdk) +- ๐Ÿ™Œ Join our [Discord](https://discord.gg/sevxWsqpGh) server to exchange ideas about unstructured data processing, AI, MLOps, and get support from the Instill AI team. We're here to support you every step of the way! + +## Documentation + +- ๐Ÿ“” **Documentation** - Check out the **[documentation](https://www.instill.tech/docs?utm_source=github&utm_medium=banner&utm_campaign=vdp_readme)** website. +- ๐Ÿ“˜ **API Reference** - Access http://localhost:3001 after `make all`, or simply run `make doc` to access the _OpenAPI documentation_. The gRPC protocols in [protobufs](https://github.com/instill-ai/protobufs) provide the single source of truth for the VDP APIs. The genuine protobuf documentation can be found in our [Buf Scheme Registry (BSR)](https://buf.build/instill-ai/protobufs). + +## Be Part of Our Community + +We strongly believe in the power of community collaboration and deeply value your contributions. Head over to our [Community](https://github.com/instill-ai/community) repository, the central hub for discussing our open-source projects, raising issues, and sharing your brilliant ideas. -For the OpenAPI documentation, access http://localhost:3001 after `make all`, or simply run `make doc`. ## Contributing Please refer to the [Contributing Guidelines](./.github/CONTRIBUTING.md) for more details. -## Community support - -Please refer to the [community](https://github.com/instill-ai/community) repository. ## License