diff --git a/README.md b/README.md index 70c53da2a..3dae0c688 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,12 @@ [![tests](https://github.com/go-skynet/LocalAI/actions/workflows/test.yml/badge.svg)](https://github.com/go-skynet/LocalAI/actions/workflows/test.yml)[![Build and Release](https://github.com/go-skynet/LocalAI/actions/workflows/release.yaml/badge.svg)](https://github.com/go-skynet/LocalAI/actions/workflows/release.yaml)[![build container images](https://github.com/go-skynet/LocalAI/actions/workflows/image.yml/badge.svg)](https://github.com/go-skynet/LocalAI/actions/workflows/image.yml)[![Bump dependencies](https://github.com/go-skynet/LocalAI/actions/workflows/bump_deps.yaml/badge.svg)](https://github.com/go-skynet/LocalAI/actions/workflows/bump_deps.yaml)[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/localai)](https://artifacthub.io/packages/search?repo=localai) +

+ +LocalAI Examples Repository + +

+ **LocalAI** is the free, Open Source OpenAI alternative. LocalAI act as a drop-in replacement REST API that's compatible with OpenAI (Elevenlabs, Anthropic... ) API specifications for local AI inferencing. It allows you to run LLMs, generate images, audio (and not only) locally or on-prem with consumer grade hardware, supporting multiple model families. Does not require GPU. It is created and maintained by [Ettore Di Giacinto](https://github.com/mudler).
diff --git a/examples/README.md b/examples/README.md index e97cd1afd..0254fad48 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,3 +1,23 @@ # LocalAI Examples -LocalAI examples were moved to a dedicated repository: https://github.com/mudler/LocalAI-examples +The examples for LocalAI have moved to a dedicated repository for easier discovery and maintenance. + +## **[Browse Examples](https://github.com/mudler/LocalAI-examples)** + +The examples repository contains ready-to-run configurations and tutorials covering: + +- **Chat & Text Generation** - LLM conversations, function calling, constrained grammars +- **Image Generation** - Stable Diffusion, diffusers, image-to-image +- **Audio** - Text-to-speech, speech-to-text, voice cloning +- **Embeddings & RAG** - Vector databases, retrieval-augmented generation +- **Integrations** - Langchain, Discord bots, Slack bots, Telegram bots +- **Advanced** - P2P inferencing, Kubernetes deployments, API usage + +Each example includes configuration files and step-by-step instructions to get started quickly. + +### Quick Links + +- **Examples Repository**: https://github.com/mudler/LocalAI-examples +- **Documentation**: https://localai.io/ +- **Model Gallery**: https://models.localai.io/ +- **Getting Started**: https://localai.io/basics/getting_started/