instill-core
# 🔮 **Instill Core** [](https://github.com/instill-ai/instill-core/actions/workflows/integration-test-latest.yml?branch=main&event=push) [](https://github.com/instill-ai/instill-core/releases) [](https://artifacthub.io/packages/helm/instill-ai/core) [](https://discord.gg/sevxWsqpGh) A complete unstructured data solution: ETL processing, AI-readiness, open-source LLM hosting, and RAG capabilities in one powerful platform. ## Quick start Follow the [installation](#installation) steps below or [documentation](https://docs.instill-ai.com/docs/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 an end-to-end AI platform for data, pipeline and model orchestration. <div align="center"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/instill-ai/.github/main/img/instill-core-stack-dark.svg"> <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/instill-ai/.github/main/img/instill-core-stack-light.svg"> <img alt="🔮 Instill Core - The full-stack AI infrastructure tool" src="https://raw.githubusercontent.com/instill-ai/.github/main/img/instill-core-stack-light.svg" width=70%> </picture> </div> 🔮 **Instill Core** simplifies infrastructure hassle and encompasses these core features: - 💧 [**Pipeline**](https://docs.instill-ai.com/docs/pipeline-introduction/?utm_source=github&utm_medium=readme&utm_campaign=org_readme): Quickly build versatile AI-first APIs or automated workflows. - ⚙️ [**Component**](https://docs.instill-ai.com/docs/component-introduction/?utm_source=github&utm_medium=readme&utm_campaign=org_readme): Connect essential building blocks to construct powerful pipelines. - 💾 [**Artifact**](https://docs.instill-ai.com/docs/artifact-introduction/?utm_source=github&utm_medium=readme&utm_campaign=org_readme): Transform unstructured data (e.g., documents, images, audio, video) into AI-ready formats. - ⚗️ [**Model**](https://docs.instill-ai.com/docs/model-introduction/?utm_source=github&utm_medium=readme&utm_campaign=org_readme): Deploy and monitor AI models without GPU infrastructure hassles. ## What can you build? - 📖 Parsing PDF Files to Markdown: [Cookbook](https://github.com/instill-ai/cookbook/blob/main/examples/Parsing_pdf_files.ipynb) - 🧱 Generating Structured Outputs from LLMs: [Cookbook](https://github.com/instill-ai/cookbook/blob/main/examples/Generating_structured_outputs.ipynb) & [Tutorial](https://www.instill-ai.com/blog/llm-structured-outputs) - 🕸️ Web scraping & Google Search with Structured Insights - 🌱 Instance segmentation on microscopic plant stomata images: [Cookbook](https://github.com/instill-ai/cookbook/blob/main/examples/Instance_segmentation_stomavision.ipynb) See [Examples](https://docs.instill-ai.com/docs/examples) for more! ## Installation ### Prerequisites | Operating System | Requirements and Instructions | | ---------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | macOS or Linux | Instill Core works natively | | Windows | • Use Windows Subsystem for Linux (WSL2)<br>• Install latest `yq` from [GitHub Repository](https://github.com/mikefarah/yq)<br>• Install latest Docker Desktop and enable WSL2 integration ([tutorial](https://docs.docker.com/desktop/wsl))<br>• (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<br>• Docker Compose v2 or later<br>• Install latest stable [Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) | ### Spin up Instill Core Execute the following commands to pull pre-built images with all the dependencies to launch: <!-- x-release-please-start-version --> ```bash git clone -b v0.58.1 https://github.com/instill-ai/instill-core.git && cd instill-core # Launch all services make run ``` <!-- x-release-please-end --> That's it! Once all the services are up with health status, the UI is ready to go at <http://localhost:3000>. Please find the default login credentials in the [documentation](https://docs.instill-ai.com/docs/quickstart#instill-core-ce-self-hosted). To shut down all running services: ```shell make down ``` ## Deployment Visit the [Deployment Overview](https://docs.instill-ai.com/docs/deployment/?utm_source=github&utm_medium=readme&utm_campaign=org_readme) for more details. ## Client Access - <b>📺 <a href="https://github.com/instill-ai/console" target="_blank">Console</a></b> - <b>⌨️ <a href="https://github.com/instill-ai/cli" target="_blank">CLI</a></b> - <b>📦 SDK</b>: - [Python SDK](https://github.com/instill-ai/python-sdk) - [TypeScript SDK](https://github.com/instill-ai/typescript-sdk) - Stay tuned, as more SDKs are on the way! ## Documentation Please visit our [official documentation](https://docs.instill-ai.com/docs?utm_source=github&utm_medium=link&utm_campaign=instill-core) for more. Additional resources: - [API Reference](https://docs.instill-ai.com/reference) - [Cookbooks](https://github.com/instill-ai/cookbook) - [Tutorials](https://www.instill-ai.com/blog) - [Examples](https://docs.instill-ai.com/docs/examples) ## Contributing 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. 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. ### Community Standards 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 by joining our [Discord community](https://discord.gg/sevxWsqpGh) where you can post any questions on our `#ask-for-help` channel. ## License See the [LICENSE](./LICENSE) file for licensing information.