From a8ed59d8f1e68439adc1a5f3a41d71f6182414ab Mon Sep 17 00:00:00 2001
From: Anni Chen <28208961+kuroxx@users.noreply.github.com>
Date: Fri, 25 Oct 2024 18:05:18 +0100
Subject: [PATCH 1/7] mod: README content
---
README.md | 121 ++++++++++++++++++++++++++++--------------------------
1 file changed, 63 insertions(+), 58 deletions(-)
diff --git a/README.md b/README.md
index 0c974e0c..2bfeeea5 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# instill-core
+# 🔮 **Instill Core**
[![Integration Test](https://img.shields.io/github/actions/workflow/status/instill-ai/instill-core/integration-test-latest.yml?branch=main&label=Integration%20Test&logoColor=fff&logo=data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMTYiIGhlaWdodD0iMTYiIHZpZXdCb3g9IjAgMCAxNiAxNiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPHBhdGggZmlsbC1ydWxlPSJldmVub2RkIiBjbGlwLXJ1bGU9ImV2ZW5vZGQiIGQ9Ik0wIDEuNzVDMCAwLjc4NCAwLjc4NCAwIDEuNzUgMEg1LjI1QzYuMjE2IDAgNyAwLjc4NCA3IDEuNzVWNS4yNUM3IDUuNzE0MTMgNi44MTU2MyA2LjE1OTI1IDYuNDg3NDQgNi40ODc0NEM2LjE1OTI1IDYuODE1NjMgNS43MTQxMyA3IDUuMjUgN0g0VjExQzQgMTEuMjY1MiA0LjEwNTM2IDExLjUxOTYgNC4yOTI4OSAxMS43MDcxQzQuNDgwNDMgMTEuODk0NiA0LjczNDc4IDEyIDUgMTJIOVYxMC43NUM5IDkuNzg0IDkuNzg0IDkgMTAuNzUgOUgxNC4yNUMxNS4yMTYgOSAxNiA5Ljc4NCAxNiAxMC43NVYxNC4yNUMxNiAxNC43MTQxIDE1LjgxNTYgMTUuMTU5MiAxNS40ODc0IDE1LjQ4NzRDMTUuMTU5MiAxNS44MTU2IDE0LjcxNDEgMTYgMTQuMjUgMTZIMTAuNzVDMTAuMjg1OSAxNiA5Ljg0MDc1IDE1LjgxNTYgOS41MTI1NiAxNS40ODc0QzkuMTg0MzcgMTUuMTU5MiA5IDE0LjcxNDEgOSAxNC4yNVYxMy41SDVDNC4zMzY5NiAxMy41IDMuNzAxMDcgMTMuMjM2NiAzLjIzMjIzIDEyLjc2NzhDMi43NjMzOSAxMi4yOTg5IDIuNSAxMS42NjMgMi41IDExVjdIMS43NUMxLjI4NTg3IDcgMC44NDA3NTIgNi44MTU2MyAwLjUxMjU2MyA2LjQ4NzQ0QzAuMTg0Mzc0IDYuMTU5MjUgMCA1LjcxNDEzIDAgNS4yNUwwIDEuNzVaTTEuNzUgMS41QzEuNjgzNyAxLjUgMS42MjAxMSAxLjUyNjM0IDEuNTczMjIgMS41NzMyMkMxLjUyNjM0IDEuNjIwMTEgMS41IDEuNjgzNyAxLjUgMS43NVY1LjI1QzEuNSA1LjM4OCAxLjYxMiA1LjUgMS43NSA1LjVINS4yNUM1LjMxNjMgNS41IDUuMzc5ODkgNS40NzM2NiA1LjQyNjc4IDUuNDI2NzhDNS40NzM2NiA1LjM3OTg5IDUuNSA1LjMxNjMgNS41IDUuMjVWMS43NUM1LjUgMS42ODM3IDUuNDczNjYgMS42MjAxMSA1LjQyNjc4IDEuNTczMjJDNS4zNzk4OSAxLjUyNjM0IDUuMzE2MyAxLjUgNS4yNSAxLjVIMS43NVpNMTAuNzUgMTAuNUMxMC42ODM3IDEwLjUgMTAuNjIwMSAxMC41MjYzIDEwLjU3MzIgMTAuNTczMkMxMC41MjYzIDEwLjYyMDEgMTAuNSAxMC42ODM3IDEwLjUgMTAuNzVWMTQuMjVDMTAuNSAxNC4zODggMTAuNjEyIDE0LjUgMTAuNzUgMTQuNUgxNC4yNUMxNC4zMTYzIDE0LjUgMTQuMzc5OSAxNC40NzM3IDE0LjQyNjggMTQuNDI2OEMxNC40NzM3IDE0LjM3OTkgMTQuNSAxNC4zMTYzIDE0LjUgMTQuMjVWMTAuNzVDMTQuNSAxMC42ODM3IDE0LjQ3MzcgMTAuNjIwMSAxNC40MjY4IDEwLjU3MzJDMTQuMzc5OSAxMC41MjYzIDE0LjMxNjMgMTAuNSAxNC4yNSAxMC41SDEwLjc1WiIgZmlsbD0id2hpdGUiLz4KPC9zdmc+Cg==)](https://github.com/instill-ai/instill-core/actions/workflows/integration-test-latest.yml?branch=main&event=push)
[![GitHub release (latest SemVer including pre-releases)](https://img.shields.io/github/v/release/instill-ai/instill-core?&label=Release&color=blue&include_prereleases&logo=data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjQiIGhlaWdodD0iMjQiIHZpZXdCb3g9IjAgMCAyNCAyNCIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPHBhdGggZD0iTTQgOEg3VjRIMjNWMTdIMjFDMjEgMTguNjYgMTkuNjYgMjAgMTggMjBDMTYuMzQgMjAgMTUgMTguNjYgMTUgMTdIOUM5IDE4LjY2IDcuNjYgMjAgNiAyMEM0LjM0IDIwIDMgMTguNjYgMyAxN0gxVjEyTDQgOFpNMTggMThDMTguNTUgMTggMTkgMTcuNTUgMTkgMTdDMTkgMTYuNDUgMTguNTUgMTYgMTggMTZDMTcuNDUgMTYgMTcgMTYuNDUgMTcgMTdDMTcgMTcuNTUgMTcuNDUgMTggMTggMThaTTQuNSA5LjVMMi41NCAxMkg3VjkuNUg0LjVaTTYgMThDNi41NSAxOCA3IDE3LjU1IDcgMTdDNyAxNi40NSA2LjU1IDE2IDYgMTZDNS40NSAxNiA1IDE2LjQ1IDUgMTdDNSAxNy41NSA1LjQ1IDE4IDYgMThaIiBmaWxsPSJ3aGl0ZSIvPgo8L3N2Zz4K)](https://github.com/instill-ai/instill-core/releases)
@@ -7,66 +7,76 @@
[![All Contributors](https://img.shields.io/badge/all_contributors-31-blue.svg?label=All%20Contributors)](#contributors-)
-Explore **🔮 [Instill Core](https://github.com/instill-ai/instill-core)**, a full-stack AI infrastructure tool for data, model and pipeline orchestration, designed to streamline every aspect of building versatile AI-first applications. Accessing **🔮 Instill Core** is straightforward, whether you opt for **☁️ Instill Cloud** or self-hosting via the [instill-core](https://github.com/instill-ai/instill-core) repository. Please consult the [documentation](https://www.instill.tech/docs/latest/core/deployment/?utm_source=github&utm_medium=readme&utm_campaign=org_readme) for more details.
-
-
-
+✨ Make your unstructured data **AI-ready** FAST & build unique versatile **AI-first** applications EASILY. ✨
-
+## Quick start
-
- 💧 Instill VDP - Pipeline orchestration for unstructured data ETL
+There are a few ways to start exploring:
-
+1. **☁️ [Instill Cloud](https://instill.tech/featured/pipelines/?utm_source=github&utm_medium=readme&utm_campaign=org_readme)** powered by **🔮 [Instill Core](https://github.com/instill-ai/instill-core)** - explore ready-to-use APIs, automations, AI Assistants and more...
+2. **Self-hosting** - see installation steps below or the [documentation](https://www.instill.tech/docs/latest/core/deployment/?utm_source=github&utm_medium=readme&utm_campaign=org_readme) for more details
- **💧 Instill VDP**, also known as **VDP (Versatile Data Pipeline)**, serves as a powerful pipeline orchestration tool tailored to address unstructured data ETL challenges.
-
+## What is Instill Core?
- **⚙️ Instill Component** is an extensible integration framework that enhances **💧 Instill VDP**, unlocking limitless possibilities. Please visit the [component](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component) package for details.
-
-
- ⚗️ Instill Model - Model orchestration for MLOps/LLMOps
+ 🔮 Instill Core : AI infrastructure tool for data, pipeline and model orchestration
-
+
+
+ 💧 Instill VDP - Pipeline orchestration for unstructured data ETL
- **⚗️ Instill Model** is an advanced MLOps/LLMOps platform focused on seamlessly model serving, fine-tuning, and monitoring for persistent performance for unstructured data ETL.
-
+
+ **💧 Instill VDP**, also known as **VDP (Versatile Data Pipeline)**, serves as a powerful pipeline orchestration tool tailored to address unstructured data ETL challenges.
+
-
- 💾 Instill Artifact - Data orchestration for unified unstructured data representation
+ **⚙️ Instill Component** is an extensible integration framework that enhances **💧 Instill VDP**, unlocking limitless possibilities. Please visit the [component](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component) package for details.
-
+
+
+
+ ⚗️ Instill Model - Model orchestration for MLOps/LLMOps
+
+
+
+ **⚗️ Instill Model** is an advanced MLOps/LLMOps platform focused on seamlessly model serving, fine-tuning, and monitoring for persistent performance for unstructured data ETL.
+
- **💾 Instill Artifact** orchestrates unstructured data to transform documents (e.g., HTML, PDF, CSV, PPTX, DOC), images (e.g., JPG, PNG, TIFF), audio (e.g., WAV, MP3 ) and video (e.g., MP4, MOV) into a unified AI-ready format. It ensures your data is clean, curated, and ready for extracting insights and building your Knowledge Base.
+
+ 💾 Instill Artifact - Data orchestration for unified unstructured data representation
+
+
+
+ **💾 Instill Artifact** orchestrates unstructured data to transform documents (e.g., HTML, PDF, CSV, PPTX, DOC), images (e.g., JPG, PNG, TIFF), audio (e.g., WAV, MP3 ) and video (e.g., MP4, MOV) into a unified AI-ready format. It ensures your data is clean, curated, and ready for extracting insights and building your Knowledge Base.
+
-### ☁️ Instill Cloud
-Not quite into self-hosting? We've got you covered with **☁️ [Instill Cloud](https://instill.tech/?utm_source=github&utm_medium=readme&utm_campaign=instill-core)**. It's a fully managed public cloud service, providing you with access to all the features of **🔮 Instill Core** without the burden of infrastructure management. All you need to do is to one-click sign up to start building your AI-first applications.
+
+ ☁️ Instill Cloud : Turn your data, pipeline, model into production-ready APIs and Assistants
-## Prerequisites
+
+ **💧 Instill VDP**, also known as **VDP (Versatile Data Pipeline)**, serves as a powerful pipeline orchestration tool tailored to address unstructured data ETL challenges.
+
-- **macOS or Linux** - **🔮 Instill Core** works on macOS or Linux
+ **⚙️ Instill Component** is an extensible integration framework that enhances **💧 Instill VDP**, unlocking limitless possibilities. Please visit the [component](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component) package for details.
+
-- **Windows** - **🔮 Instill Core** works on Windows through Windows Linux Subsystem (WSL2)
- - Install the lastest version of `yq` from the GitHub [Repository](https://github.com/mikefarah/yq), as the package `yq` is not installed on Ubuntu WSL2 by default
+## Installation
- - Install the latest version of Docker Desktop on Windows and enable the WSL2 integration following the [tutorial](https://docs.docker.com/desktop/wsl) by Docker
+### Prerequisites
- - (optional) Install `cuda-toolkit` on WSL2 following the [tutorial](https://docs.nvidia.com/cuda/wsl-user-guide/index.html#getting-started-with-cuda-on-wsl-2) by NVIDIA
+| Operating System | Requirements and Instructions |
+|------------------|--------------------------------|
+| macOS or Linux | Instill Core works natively |
+| Windows | • Use Windows Subsystem for Linux (WSL2) • Install latest `yq` from [GitHub Repository](https://github.com/mikefarah/yq) • Install latest Docker Desktop and enable WSL2 integration ([tutorial](https://docs.docker.com/desktop/wsl)) • (Optional) Install `cuda-toolkit` on WSL2 ([NVIDIA tutorial](https://docs.nvidia.com/cuda/wsl-user-guide/index.html#getting-started-with-cuda-on-wsl-2)) |
+| All Systems | • Docker Engine v25 or later • Docker Compose v2 or later • Install latest stable [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) |
-- **Docker and Docker Compose** - **🔮 Instill Core** requires Docker Engine `v25` or later and Docker Compose `v2` or later to run all services locally. Please install the latest stable [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/).
-## Quick Start
+### Steps
**Use stable release version**
@@ -119,43 +129,38 @@ To access **🔮 Instill Core** and **☁️ Instill Cloud**, you have a few opt
## Documentation
- For comprehensive guidance and resources, explore our [documentation website](https://www.instill.tech/docs?utm_source=github&utm_medium=link&utm_campaign=instill-core) and delve into our [API reference](https://openapi.instill.tech).
-
-## Contributing
-
-We welcome contributions from the community! Whether you're a developer, designer, writer, or user, there are multiple ways to contribute:
-
-### Issue Guidelines
+For comprehensive documentation, please visit our [official documentation](https://www.instill.tech/docs?utm_source=github&utm_medium=link&utm_campaign=instill-core).
-We foster a friendly and inclusive environment for issue reporting. Before creating an issue, check if it already exists. Use clear language and provide reproducible steps for bugs. Accurately tag the issue (bug, improvement, question, etc.).
+Additional helpful resources:
-### Code Contributions
+- [API Reference](https://openapi.instill.tech)
+- [Cookbooks](https://github.com/instill-ai/cookbook)
+- [Tutorials](https://www.instill.tech/blog)
+- [Examples](https://www.instill.tech/docs/examples)
-Please refer to the [Contributing Guidelines](./.github/CONTRIBUTING.md) for more details. Your code-driven innovations are more than welcome!
+## Contributing
-## Community
+We enthusiastically welcome contributions from our community! Whether you're a developer, designer, writer, or user, there are multiple ways to get involved:
-We are committed to providing a respectful and welcoming atmosphere for all contributors. Please review our [Code of Conduct](https://github.com/instill-ai/.github/blob/main/.github/CODE_OF_CONDUCT.md) to understand our standards.
+1. **Cookbooks**: Help us create helpful pipelines and guides for the community. Visit our [Cookbook repository](https://github.com/instill-ai/cookbook) to get started.
-### Efficient Triage Process
+2. **Issues**: Contribute to improvements by raising tickets using [templates here](https://github.com/instill-ai/instill-core/issues/new/choose) or discuss in existing ones you think you can help with.
-We have implemented a streamlined [Issues Triage Process](.github/triage.md) aimed at swiftly categorizing new issues and pull requests (PRs), allowing us to take prompt and appropriate actions.
+### Community Standards
-### Engage in Dynamic Discussions and Seek Support
+We are committed to maintaining a respectful and welcoming atmosphere for all contributors. Before contributing, please review our:
-Head over to our [Discussions](https://github.com/orgs/instill-ai/discussions) for engaging conversations:
+- [Contributing Guidelines](./.github/CONTRIBUTING.md)
+- [Code of Conduct](https://github.com/instill-ai/.github/blob/main/.github/CODE_OF_CONDUCT.md)
-- [General](https://github.com/orgs/instill-ai/discussions/categories/general): Chat about anything related to our projects.
-- [Polls](https://github.com/orgs/instill-ai/discussions/categories/polls): Participate in community polls.
-- [Q&A](https://github.com/orgs/instill-ai/discussions/categories/q-a): Seek help or ask questions; our community members and maintainers are here to assist.
-- [Show and Tell](https://github.com/orgs/instill-ai/discussions/categories/show-and-tell): Showcase projects you've created using our tools.
+### Support
-Alternatively, you can also join our vibrant [Discord](https://discord.gg/sevxWsqpGh) community and direct your queries to the #ask-for-help channel. We're dedicated to supporting you every step of the way.
+Get help to your queries by joining our [Discord community](https://discord.gg/sevxWsqpGh) where you can post any questions on our `#ask-for-help` channel.
## Contributors ✨
-Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+Thank you to all these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
From 38e1fc88d8ca20be86c79936c418df8274c4ed24 Mon Sep 17 00:00:00 2001
From: Anni Chen <28208961+kuroxx@users.noreply.github.com>
Date: Mon, 28 Oct 2024 11:39:22 +0000
Subject: [PATCH 2/7] mod: update readme
---
README.md | 68 ++++++++++++++++---------------------------------------
1 file changed, 20 insertions(+), 48 deletions(-)
diff --git a/README.md b/README.md
index 2bfeeea5..6ad9852d 100644
--- a/README.md
+++ b/README.md
@@ -14,56 +14,28 @@
There are a few ways to start exploring:
-1. **☁️ [Instill Cloud](https://instill.tech/featured/pipelines/?utm_source=github&utm_medium=readme&utm_campaign=org_readme)** powered by **🔮 [Instill Core](https://github.com/instill-ai/instill-core)** - explore ready-to-use APIs, automations, AI Assistants and more...
-2. **Self-hosting** - see installation steps below or the [documentation](https://www.instill.tech/docs/latest/core/deployment/?utm_source=github&utm_medium=readme&utm_campaign=org_readme) for more details
+1. **[Instill Cloud](https://instill.tech/featured/pipelines/?utm_source=github&utm_medium=readme&utm_campaign=org_readme)**: Explore our public cloud powered by [Instill Core](https://github.com/instill-ai/instill-core) with ready-to-use APIs, automations, AI Assistants and more. See the [quickstart](https://www.instill.tech/docs/quickstart#%EF%B8%8F-instill-cloud) on how to get started.
+2. **Self-hosting Instill Core**: Follow the [installation](#installation) steps below or [documentation](https://www.instill.tech/docs/latest/core/deployment/?utm_source=github&utm_medium=readme&utm_campaign=org_readme) for more details to build versatile AI applications locally.
## What is Instill Core?
+**[Instill Core](https://github.com/instill-ai/instill-core)** is your end-to-end AI platform for data, pipeline and model orchestration.
-
- 🔮 Instill Core : AI infrastructure tool for data, pipeline and model orchestration
+
+
+
-
-
- 💧 Instill VDP - Pipeline orchestration for unstructured data ETL
-
-
- **💧 Instill VDP**, also known as **VDP (Versatile Data Pipeline)**, serves as a powerful pipeline orchestration tool tailored to address unstructured data ETL challenges.
-
-
- **⚙️ Instill Component** is an extensible integration framework that enhances **💧 Instill VDP**, unlocking limitless possibilities. Please visit the [component](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component) package for details.
-
-
-
-
- ⚗️ Instill Model - Model orchestration for MLOps/LLMOps
-
-
-
- **⚗️ Instill Model** is an advanced MLOps/LLMOps platform focused on seamlessly model serving, fine-tuning, and monitoring for persistent performance for unstructured data ETL.
-
-
-
- 💾 Instill Artifact - Data orchestration for unified unstructured data representation
-
-
-
- **💾 Instill Artifact** orchestrates unstructured data to transform documents (e.g., HTML, PDF, CSV, PPTX, DOC), images (e.g., JPG, PNG, TIFF), audio (e.g., WAV, MP3 ) and video (e.g., MP4, MOV) into a unified AI-ready format. It ensures your data is clean, curated, and ready for extracting insights and building your Knowledge Base.
-
-
-
-
-
- ☁️ Instill Cloud : Turn your data, pipeline, model into production-ready APIs and Assistants
-
-
- **💧 Instill VDP**, also known as **VDP (Versatile Data Pipeline)**, serves as a powerful pipeline orchestration tool tailored to address unstructured data ETL challenges.
-
-
- **⚙️ Instill Component** is an extensible integration framework that enhances **💧 Instill VDP**, unlocking limitless possibilities. Please visit the [component](https://github.com/instill-ai/pipeline-backend/blob/main/pkg/component) package for details.
-
+**Instill Core** simplifies infrastructure hassle, encompassing these core features:
+- **DATA - [Instill Artifact](https://www.instill.tech/docs/artifact/introduction//?utm_source=github&utm_medium=readme&utm_campaign=org_readme)**: Transforms unstructured data (documents, images, audio, video) into AI-ready formats.
+- **PIPELINE - [Instill VDP](https://www.instill.tech/docs/vdp/introduction//?utm_source=github&utm_medium=readme&utm_campaign=org_readme)**: Quickly build any versatile AI-first applications with dynamic API-ready endpoints.
+- **MODEL - [Instill Model](https://www.instill.tech/docs/model/introduction//?utm_source=github&utm_medium=readme&utm_campaign=org_readme)**: MLOps/LLMOps platform for model serving and monitoring.
+
## Installation
@@ -129,9 +101,9 @@ To access **🔮 Instill Core** and **☁️ Instill Cloud**, you have a few opt
## Documentation
-For comprehensive documentation, please visit our [official documentation](https://www.instill.tech/docs?utm_source=github&utm_medium=link&utm_campaign=instill-core).
+Please visit our [official documentation](https://www.instill.tech/docs?utm_source=github&utm_medium=link&utm_campaign=instill-core) for more.
-Additional helpful resources:
+Additional resources:
- [API Reference](https://openapi.instill.tech)
- [Cookbooks](https://github.com/instill-ai/cookbook)
@@ -140,7 +112,7 @@ Additional helpful resources:
## Contributing
-We enthusiastically welcome contributions from our community! Whether you're a developer, designer, writer, or user, there are multiple ways to get involved:
+We welcome contributions from our community! Checkout the methods below:
1. **Cookbooks**: Help us create helpful pipelines and guides for the community. Visit our [Cookbook repository](https://github.com/instill-ai/cookbook) to get started.
@@ -148,14 +120,14 @@ We enthusiastically welcome contributions from our community! Whether you're a d
### Community Standards
-We are committed to maintaining a respectful and welcoming atmosphere for all contributors. Before contributing, please review our:
+We are committed to maintaining a respectful and welcoming atmosphere for all contributors. Before contributing, please read:
- [Contributing Guidelines](./.github/CONTRIBUTING.md)
- [Code of Conduct](https://github.com/instill-ai/.github/blob/main/.github/CODE_OF_CONDUCT.md)
### Support
-Get help to your queries by joining our [Discord community](https://discord.gg/sevxWsqpGh) where you can post any questions on our `#ask-for-help` channel.
+Get help by joining our [Discord community](https://discord.gg/sevxWsqpGh) where you can post any questions on our `#ask-for-help` channel.
## Contributors ✨
From 484c2c13c257e1b964f9143b15a56ec0571b8b1a Mon Sep 17 00:00:00 2001
From: Anni Chen <28208961+kuroxx@users.noreply.github.com>
Date: Mon, 28 Oct 2024 16:38:06 +0000
Subject: [PATCH 3/7] chore(readme): update README content
---
README.md | 36 +++++++++++++++++++++++++++++++++++-
1 file changed, 35 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 6ad9852d..5b6e7e5a 100644
--- a/README.md
+++ b/README.md
@@ -30,13 +30,23 @@ There are a few ways to start exploring:
-**Instill Core** simplifies infrastructure hassle, encompassing these core features:
+**Instill Core** simplifies infrastructure hassle and encompasses these core features:
- **DATA - [Instill Artifact](https://www.instill.tech/docs/artifact/introduction//?utm_source=github&utm_medium=readme&utm_campaign=org_readme)**: Transforms unstructured data (documents, images, audio, video) into AI-ready formats.
- **PIPELINE - [Instill VDP](https://www.instill.tech/docs/vdp/introduction//?utm_source=github&utm_medium=readme&utm_campaign=org_readme)**: Quickly build any versatile AI-first applications with dynamic API-ready endpoints.
- **MODEL - [Instill Model](https://www.instill.tech/docs/model/introduction//?utm_source=github&utm_medium=readme&utm_campaign=org_readme)**: MLOps/LLMOps platform for model serving and monitoring.
+## What can you build?
+
+- 📖 Parsing PDF Files to Markdown: [Cookbook](https://github.com/instill-ai/cookbook/blob/main/examples/Parsing_pdf_files.ipynb)
+- 🌱 Instance segmentation on microscopic plant stomata images: [Cookbook](https://github.com/instill-ai/cookbook/blob/main/examples/Instance_segmentation_stomavision.ipynb)
+- 🧱 Generating Structured Outputs from LLMs: [Cookbook](https://github.com/instill-ai/cookbook/blob/main/examples/Generating_structured_outputs.ipynb) & [Tutorial](https://www.instill.tech/blog/llm-structured-outputs)
+- 🕸️ Web scraping & Google Search with Structured Insights: [Tutorial](https://www.instill.tech/blog/mastering-openai-structured-outputs) & [YouTube](https://www.youtube.com/watch?v=x0XsmuCrit8)
+
+See [Examples](https://www.instill.tech/docs/examples) for more!
+
+
## Installation
### Prerequisites
@@ -181,6 +191,30 @@ Thank you to all these wonderful people ([emoji key](https://allcontributors.org
From c1efc17eb0253ce56af73dc5770714ad323485f0 Mon Sep 17 00:00:00 2001
From: Anni <28208961+kuroxx@users.noreply.github.com>
Date: Fri, 1 Nov 2024 17:29:09 +0000
Subject: [PATCH 4/7] Update README.md
Co-authored-by: Xiaofei Du
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 5b6e7e5a..dfbbcc31 100644
--- a/README.md
+++ b/README.md
@@ -40,9 +40,9 @@ There are a few ways to start exploring:
## What can you build?
- 📖 Parsing PDF Files to Markdown: [Cookbook](https://github.com/instill-ai/cookbook/blob/main/examples/Parsing_pdf_files.ipynb)
-- 🌱 Instance segmentation on microscopic plant stomata images: [Cookbook](https://github.com/instill-ai/cookbook/blob/main/examples/Instance_segmentation_stomavision.ipynb)
- 🧱 Generating Structured Outputs from LLMs: [Cookbook](https://github.com/instill-ai/cookbook/blob/main/examples/Generating_structured_outputs.ipynb) & [Tutorial](https://www.instill.tech/blog/llm-structured-outputs)
- 🕸️ Web scraping & Google Search with Structured Insights: [Tutorial](https://www.instill.tech/blog/mastering-openai-structured-outputs) & [YouTube](https://www.youtube.com/watch?v=x0XsmuCrit8)
+- 🌱 Instance segmentation on microscopic plant stomata images: [Cookbook](https://github.com/instill-ai/cookbook/blob/main/examples/Instance_segmentation_stomavision.ipynb)
See [Examples](https://www.instill.tech/docs/examples) for more!
From 46ba835c407f6ed43e13bdf3e4898a0f012af8dc Mon Sep 17 00:00:00 2001
From: Anni <28208961+kuroxx@users.noreply.github.com>
Date: Fri, 1 Nov 2024 17:29:13 +0000
Subject: [PATCH 5/7] Update README.md
Co-authored-by: Xiaofei Du
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index dfbbcc31..b3e8e426 100644
--- a/README.md
+++ b/README.md
@@ -33,7 +33,7 @@ There are a few ways to start exploring:
**Instill Core** simplifies infrastructure hassle and encompasses these core features:
- **DATA - [Instill Artifact](https://www.instill.tech/docs/artifact/introduction//?utm_source=github&utm_medium=readme&utm_campaign=org_readme)**: Transforms unstructured data (documents, images, audio, video) into AI-ready formats.
-- **PIPELINE - [Instill VDP](https://www.instill.tech/docs/vdp/introduction//?utm_source=github&utm_medium=readme&utm_campaign=org_readme)**: Quickly build any versatile AI-first applications with dynamic API-ready endpoints.
+- **PIPELINE - [Instill VDP](https://www.instill.tech/docs/vdp/introduction//?utm_source=github&utm_medium=readme&utm_campaign=org_readme)**: Quickly build any versatile AI-first APIs or automated workflows.
- **MODEL - [Instill Model](https://www.instill.tech/docs/model/introduction//?utm_source=github&utm_medium=readme&utm_campaign=org_readme)**: MLOps/LLMOps platform for model serving and monitoring.
From d9b74c7c5aae42707d7f058b3b6638c4e729dbfc Mon Sep 17 00:00:00 2001
From: Anni Chen <28208961+kuroxx@users.noreply.github.com>
Date: Mon, 4 Nov 2024 09:21:27 +0000
Subject: [PATCH 6/7] chore(readme): update instill-core stack & deployment
diagrams
---
README.md | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/README.md b/README.md
index b3e8e426..4cfb6792 100644
--- a/README.md
+++ b/README.md
@@ -36,6 +36,13 @@ There are a few ways to start exploring:
- **PIPELINE - [Instill VDP](https://www.instill.tech/docs/vdp/introduction//?utm_source=github&utm_medium=readme&utm_campaign=org_readme)**: Quickly build any versatile AI-first APIs or automated workflows.
- **MODEL - [Instill Model](https://www.instill.tech/docs/model/introduction//?utm_source=github&utm_medium=readme&utm_campaign=org_readme)**: MLOps/LLMOps platform for model serving and monitoring.
+
+
+
## What can you build?
From 33c0483b1165e60f953172efc236a64ff9289c7c Mon Sep 17 00:00:00 2001
From: Anni Chen <28208961+kuroxx@users.noreply.github.com>
Date: Mon, 4 Nov 2024 11:45:17 +0000
Subject: [PATCH 7/7] chore(readme): update readme deployment section
---
README.md | 23 ++++++++++++++---------
1 file changed, 14 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
index 4cfb6792..72a39e40 100644
--- a/README.md
+++ b/README.md
@@ -35,14 +35,7 @@ There are a few ways to start exploring:
- **DATA - [Instill Artifact](https://www.instill.tech/docs/artifact/introduction//?utm_source=github&utm_medium=readme&utm_campaign=org_readme)**: Transforms unstructured data (documents, images, audio, video) into AI-ready formats.
- **PIPELINE - [Instill VDP](https://www.instill.tech/docs/vdp/introduction//?utm_source=github&utm_medium=readme&utm_campaign=org_readme)**: Quickly build any versatile AI-first APIs or automated workflows.
- **MODEL - [Instill Model](https://www.instill.tech/docs/model/introduction//?utm_source=github&utm_medium=readme&utm_campaign=org_readme)**: MLOps/LLMOps platform for model serving and monitoring.
-
-
-
-
+
## What can you build?
@@ -106,9 +99,21 @@ $ make down
Explore the [documentation](https://www.instill.tech/docs/latest/core/deployment) to discover all available deployment options.
+## Deployment
+
+You can either self-host **🔮 Instill Core** or choose our fully managed **☁️ Instill Cloud** to get access to all the latest features. Visit the [Deployment Overview](https://www.instill.tech/docs/core/deployment) for more details.
+
+
+
+
+
+
## Client Access
-To access **🔮 Instill Core** and **☁️ Instill Cloud**, you have a few options:
- 📺 Instill Console
- ⌨️ Instill CLI
- 📦 Instill SDK: