Awesome
🔮 Instill Core
✨ Make your unstructured data AI-ready FAST & build unique versatile AI-first applications EASILY. ✨
Quick start
There are a few ways to start exploring:
- Instill Cloud: Explore our public cloud powered by Instill Core with ready-to-use APIs, automations, AI Assistants and more. See the quickstart on how to get started.
- Self-hosting Instill Core: Follow the installation steps below or documentation for more details to build versatile AI applications locally.
What is Instill Core?
Instill Core is your 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:
- DATA - Instill Artifact: Transforms unstructured data (documents, images, audio, video) into AI-ready formats.
- PIPELINE - Instill VDP: Quickly build any versatile AI-first APIs or automated workflows.
- MODEL - Instill Model: MLOps/LLMOps platform for model serving and monitoring.
What can you build?
- 📖 Parsing PDF Files to Markdown: Cookbook
- 🧱 Generating Structured Outputs from LLMs: Cookbook & Tutorial
- 🕸️ Web scraping & Google Search with Structured Insights: Tutorial & YouTube
- 🌱 Instance segmentation on microscopic plant stomata images: Cookbook
See 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<br>• Install latest Docker Desktop and enable WSL2 integration (tutorial)<br>• (Optional) Install cuda-toolkit on WSL2 (NVIDIA tutorial) |
| All Systems | • Docker Engine v25 or later<br>• Docker Compose v2 or later<br>• Install latest stable Docker and Docker Compose |
Steps
Use stable release version
Execute the following commands to pull pre-built images with all the dependencies to launch:
<!-- x-release-please-start-version -->$ git clone -b v0.45.0-beta https://github.com/instill-ai/instill-core.git && cd instill-core
# Launch all services
$ make all
[!NOTE] We have restructured our project repositories. If you need to access 🔮 Instill Core projects up to version
v0.13.0-beta, please refer to the instill-ai/deprecated-core repository.
Use the latest version for local development
Execute the following commands to build images with all the dependencies to launch:
$ git clone https://github.com/instill-ai/instill-core.git && cd instill-core
# Launch all services
$ make latest PROFILE=all
[!IMPORTANT] 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.
🚀 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.
To shut down all running services:
$ make down
Explore the documentation 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 for more details.
<div align="center"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/instill-ai/.github/main/img/instill-core-deployment-dark.svg"> <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/instill-ai/.github/main/img/instill-core-deployment-light.svg"> <img alt="🔮 Instill Core - Deployment" src="https://raw.githubusercontent.com/instill-ai/.github/main/img/instill-core-stack-light.svg" width=70%> </picture> </div>Client Access
- <b>📺 <a href="https://github.com/instill-ai/console" target="_blank">Instill Console</a></b>
- <b>⌨️ <a href="https://github.com/instill-ai/cli" target="_blank">Instill CLI</a></b>
- <b>📦 Instill SDK</b>:
- Python SDK
- TypeScript SDK
- Stay tuned, as more SDKs are on the way!
Documentation
Please visit our official documentation for more.
Additional resources:
Contributing
We welcome contributions from our community! Checkout the methods below:
-
Cookbooks: Help us create helpful pipelines and guides for the community. Visit our Cookbook repository to get started.
-
Issues: Contribute to improvements by raising tickets using templates here 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:
Support
Get help by joining our Discord community where you can post any questions on our #ask-for-help channel.
Contributors ✨
Thank you to all these wonderful people (emoji key):
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> <table> <tbody> <tr> <td align="center" valign="top" width="16.66%"><a href="https://github.com/VibhorGits"><img src="https://avatars.githubusercontent.com/u/110928899?v=4" width="100px;" alt=""/><br /><sub><b>Vibhor Bhatt</b></sub></a></td> <td align="center" valign="top" width="16.66%"><a href="https://github.com/miguel-ortiz-marin"><img src="https://avatars.githubusercontent.com/u/89418691?v=4" width="100px;" alt=""/><br /><sub><b>Miguel Ortiz</b></sub></a></td> <td align="center" valign="top" width="16.66%"><a href="https://github.com/sajdakabir"><img src="https://avatars.githubusercontent.com/u/86569763?v=4" width="100px;" alt=""/><br /><sub><b>Sajda Kabir</b></sub></a></td> <td align="center" valign="top" width="16.66%"><a href="https://github.com/chenhunghan"><img src="https://avatars.githubusercontent.com/u/1474479?v=4" width="100px;" alt=""/><br /><sub><b>Henry Chen</b></sub></a></td> <td align="center" valign="top" width="16.66%"><a href="https://github.com/HariBhandari07"><img src="https://avatars.githubusercontent.com/u/34328907?v=4" width="100px;" alt=""/><br /><sub><b>Hari Bhandari</b></sub></a></td> <td align="center" valign="top" width="16.66%"><a href="https://github.com/geeksambhu"><img src="https://avatars.githubusercontent.com/u/9899283?v=4" width="100px;" alt=""/><br /><sub><b>Shiva Gaire</b></sub></a></td> </tr> <tr> <td align="center" valign="top" width="16.66%"><a href="https://github.com/syedzubeen"><img src="https://avatars.githubusercontent.com/u/14253061?v=4" width="100px;" alt=""/><br /><sub><b>Zubeen</b></sub></a></td> <td align="center" valign="top" width="16.66%"><a href="https://github.com/ShihChun-H"><img src="https://avatars.githubusercontent.com/u/143982976?v=4" width="100px;" alt=""/><br /><sub><b>ShihChun-H</b></sub></a></td> <td align="center" valign="top" width="16.66%"><a href="https://github.com/eltociear"><img src="https://avatars.githubusercontent.com/u/22633385?v=4" width="100px;" alt=""/><br /><sub><b>Ikko Eltociear Ashimine</b></sub></a></td> <td align="center" valign="top" width="16.66%"><a href="https://github.com/FarukhS52"><img src="https://avatars.githubusercontent.com/u/129654632?v=4" width="100px;" alt=""/><br /><sub><b>Farookh Zaheer Siddiqui</b></sub></a></td> <td align="center" valign="top" width="16.66%"><a href="https://github.com/diamondsea"><img src="https://avatars.githubusercontent.com/u/847589?v=4" width="100px;" alt=""/><br /><sub><b>Brian Gallagher</b></sub></a></td> <td align="center" valign="top" width="16.66%"><a href="https://github.com/hairyputtar"><img src="https://avatars.githubusercontent.com/u/148847552?v=4" width="100px;" alt=""/><br /><sub><b>hairyputtar</b></sub></a></td> </tr> <tr> <td align="center" valign="top" width="16.66%"><a href="https://github.com/dmarx"><img src="https://avatars.githubusercontent.com/u/1466881?v=4" width="100px;" alt=""/><br /><sub><b>David Marx</b></sub></a></td> <td align="center" valign="top" width="16.66%"><a href="https://github.com/DenizParlak"><img src="https://avatars.githubusercontent.com/u/11199794?v=4" width="100px;" alt=""/><br /><sub><b>Deniz Parlak</b></sub></a></td> <td align="center" valign="top" width="16.66%"><a href="https://github.com/bryan107"><img src="https://avatars.githubusercontent.com/u/8025085?v=4" width="100px;" alt=""/><br /><sub><b>Po-Yu Chen</b></sub></a></td> <td align="center" valign="top" width="16.66%"><a href="https://github.com/EiffelFly"><img src="https://avatars.githubusercontent.com/u/57251712?v=4" width="100px;" alt=""/><br /><sub><b>Po Chun Chiu</b></sub></a></td> <td align="center" valign="top" width="16.66%"><a href="https://github.com/Sarthak-instill"><img src="https://avatars.githubusercontent.com/u/134260133?v=4" width="100px;" alt=""/><br /><sub><b>Sarthak</b></sub></a></td> <td align="center" valign="top" width="16.66%"><a href="https://github.com/heiruwu"><img src="https://avatars.githubusercontent.com/u/5631010?v=4" width="100px;" alt=""/><br /><sub><b>HR Wu</b></sub></a></td> </tr> <tr> <td align="center" valign="top" width="16.66%"><a href="https://github.com/Phelan164"><img src="https://avatars.githubusercontent.com/u/2509508?v=4" width="100px;" alt=""/><br /><sub><b>phelan</b></sub></a></td> <td align="center" valign="top" width="16.66%"><a href="https://github.com/donch1989"><img src="https://avatars.githubusercontent.com/u/441005?v=4" width="100px;" alt=""/><br /><sub><b>Chang, Hui-Tang</b></sub></a></td> <td align="center" valign="top" width="16.66%"><a href="https://github.com/xiaofei-du"><img src="https://avatars.githubusercontent.com/u/66248476?v=4" width="100px;" alt=""/><br /><sub><b>Xiaofei Du</b></sub></a></td> <td align="center" valign="top" width="16.66%"><a href="https://github.com/pinglin"><img src="https://avatars.githubusercontent.com/u/628430?v=4" width="100px;" alt=""/><br /><sub><b>Ping-Lin Chang</b></sub></a></td> <td align="center" valign="top" width="16.66%"><a href="https://github.com/tonywang10101"><img src="https://avatars.githubusercontent.com/u/78333580?v=4" width="100px;" alt=""/><br /><sub><b>Tony Wang</b></sub></a></td> <td align="center" valign="top" width="16.66%"><a href="https://github.com/Pratikdate"><img src="https://avatars.githubusercontent.com/u/91735895?v=4" width="100px;" alt=""/><br /><sub><b>Pratik date</b></sub></a></td> </tr> <tr> <td align="center" valign="top" width="16.66%"><a href="https://github.com/jvallesm"><img src="https://avatars.githubusercontent.com/u/3977183?v=4" width="100px;" alt=""/><br /><sub><b>Juan Vallés</b></sub></a></td> <td align="center" valign="top" width="16.66%"><a href="https://github.com/iamnamananand996"><img src="https://avatars.githubusercontent.com/u/31537362?v=4" width="100px;" alt=""/><br /><sub><b>Naman Anand</b></sub></a></td> <td align="center" valign="top" width="16.66%"><a href="https://github.com/totuslink"><img src="https://avatars.githubusercontent.com/u/78023102?v=4" width="100px;" alt=""/><br /><sub><b>totuslink</b></sub></a></td> <td align="center" valign="top" width="16.66%"><a href="https://github.com/praharshjain"><img src="https://avatars.githubusercontent.com/u/12197448?v=4" width="100px;" alt=""/><br /><sub><b>Praharsh Jain</b></sub></a></td> <td align="center" valign="top" width="16.66%"><a href="https://github.com/Smartmind12"><img src="https://avatars.githubusercontent.com/u/91927689?v=4" width="100px;" alt=""/><br /><sub><b>Utsav Paul</b></sub></a></td> <td align="center" valign="top" width="16.66%"><a href="https://github.com/CaCaBlocker"><img src="https://avatars.githubusercontent.com/u/87882515?v=4" width="100px;" alt=""/><br /><sub><b>CaCaBlocker</b></sub></a></td> </tr> <tr> <td align="center" valign="top" width="16.66%"><a href="https://github.com/rsmelo92"><img src="https://avatars.githubusercontent.com/u/16295402?v=4" width="100px;" alt=""/><br /><sub><b>Rafael Melo</b></sub></a></td> <td align="center" valign="top" width="16.66%"><a href="https://github.com/joremysh"><img src="https://avatars.githubusercontent.com/u/7455516?v=4" width="100px;" alt=""/><br /><sub><b>Jeremy Shih</b></sub></a></td> <td align="center" valign="top" width="16.66%"><a href="https://github.com/Reckadon"><img src="https://avatars.githubusercontent.com/u/69901221?v=4" width="100px;" alt=""/><br /><sub><b>Romit Mohane</b></sub></a></td> <td align="center" valign="top" width="16.66%"><a href="https://github.com/chuang8511"><img src="https://avatars.githubusercontent.com/u/64747455?v=4" width="100px;" alt=""/><br /><sub><b>ChunHao</b></sub></a></td> <td align="center" valign="top" width="16.66%"><a href="https://github.com/AmeliaCelline"><img src="https://avatars.githubusercontent.com/u/71268735?v=4" width="100px;" alt=""/><br /><sub><b>Amelia C</b></sub></a></td> <td align="center" valign="top" width="16.66%"><a href="https://github.com/YCK1130"><img src="https://avatars.githubusercontent.com/u/85488391?v=4" width="100px;" alt=""/><br /><sub><b>楊竣凱</b></sub></a></td> </tr> <tr> <td align="center" valign="top" width="16.66%"><a href="https://github.com/namwoam"><img src="https://avatars.githubusercontent.com/u/54308739?v=4" width="100px;" alt=""/><br /><sub><b>andre.liang</b></sub></a></td> <td align="center" valign="top" width="16.66%"><a href="https://github.com/zidanehakim"><img src="https://avatars.githubusercontent.com/u/138553907?v=4" width="100px;" alt=""/><br /><sub><b>Zoodane</b></sub></a></td> <td align="center" valign="top" width="16.66%"><a href="https://github.com/GeorgeWilliamStrong"><img src="https://avatars.githubusercontent.com/u/42313440?v=4" width="100px;" alt=""/><br /><sub><b>George Strong</b></sub></a></td> <td align="center" valign="top" width="16.66%"><a href="https://github.com/kuroxx"><img src="https://avatars.githubusercontent.com/u/28208961?v=4" width="100px;" alt=""/><br /><sub><b>Anni</b></sub></a></td> <td align="center" valign="top" width="16.66%"><a href="https://github.com/MubeenKodvavi"><img src="https://avatars.githubusercontent.com/u/64799500?v=4" width="100px;" alt=""/><br /><sub><b>Mubeen Kodvavi</b></sub></a></td> <td align="center" valign="top" width="16.66%"><a href="https://github.com/orangecoloured"><img src="https://avatars.githubusercontent.com/u/3314891?v=4" width="100px;" alt=""/><br /><sub><b>RCKT</b></sub></a></td> </tr> <tr> <td align="center" valign="top" width="16.66%"><a href="https://github.com/thewbuk"><img src="https://avatars.githubusercontent.com/u/57405495?v=4" width="100px;" alt=""/><br /><sub><b>Wojciech Bandzerewicz <td align="center" valign="top" width="16.66%"><a href="https://github.com/Yougigun"><img src="https://avatars.githubusercontent.com/u/9638997?v=4" width="100px;" alt=""/><br /><sub><b>Gary <td align="center" valign="top" width="16.66%"><a href="https://github.com/tychen5"><img src="https://avatars.githubusercontent.com/u/32350278?v=4" width="100px;" alt=""/><br /><sub><b>Leo <td align="center" valign="top" width="16.66%"><a href="https://github.com/felixcorleone"><img src="https://avatars.githubusercontent.com/u/63280818?v=4" width="100px;" alt=""/><br /><sub><b>felixcorleone <td align="center" valign="top" width="16.66%"><a href="https://github.com/sunzoeee"><img src="https://avatars.githubusercontent.com/u/174593595?v=4" width="100px;" alt=""/><br /><sub><b>Zoe <td align="center" valign="top" width="16.66%"><a href="https://github.com/dloopy"><img src="https://avatars.githubusercontent.com/u/19646065?v=4" width="100px;" alt=""/><br /><sub><b>Daniel</b></sub></a></td> </tr> <tr> <td align="center" valign="top" width="16.66%"><a href="https://github.com/manulthanura"><img src="https://avatars.githubusercontent.com/u/91767649?v=4" width="100px;" alt=""/><br /><sub><b>Manul Thanura</b></sub></a></td> </tr> </tbody> </table> <!-- markdownlint-restore --> <!-- prettier-ignore-end --> <!-- ALL-CONTRIBUTORS-LIST:END -->This project follows the all-contributors specification. Contributions of any kind welcome!
License
See the LICENSE file for licensing information.