From 730645b3c6696cec654d7726dd7e3d53104586b7 Mon Sep 17 00:00:00 2001 From: mudler Date: Wed, 28 Jun 2023 19:26:25 +0200 Subject: [PATCH] Update README --- README.md | 30 ++++++++++++++++++++---------- 1 file changed, 20 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index c2887ade..d5cc93ad 100644 --- a/README.md +++ b/README.md @@ -9,21 +9,29 @@ [![](https://dcbadge.vercel.app/api/server/uJAeKSAGDy?style=flat-square&theme=default-inverted)](https://discord.gg/uJAeKSAGDy) -**LocalAI** is a drop-in replacement REST API that’s compatible with OpenAI API specifications for local inferencing. It allows you to run LLMs (and not only) locally or on-prem with consumer grade hardware, supporting multiple model families that are compatible with the ggml format. Does not require GPU. +[Documentation website](https://localai.io/) + +**LocalAI** is a drop-in replacement REST API that's compatible with OpenAI API specifications for local inferencing. It allows you to run LLMs (and not only) locally or on-prem with consumer grade hardware, supporting multiple model families that are compatible with the ggml format. Does not require GPU. For a list of the supported model families, please see [the model compatibility table](https://localai.io/model-compatibility/index.html#model-compatibility-table). In a nutshell: - Local, OpenAI drop-in alternative REST API. You own your data. -- NO GPU required. NO Internet access is required either. Optional, GPU Acceleration is available in `llama.cpp`-compatible LLMs. [See building instructions](https://localai.io/basics/build/index.html). -- Supports multiple models, Audio transcription, Text generation with GPTs, Image generation with stable diffusion (experimental) -- Once loaded the first time, it keep models loaded in memory for faster inference -- Doesn't shell-out, but uses C++ bindings for a faster inference and better performance. +- NO GPU required. NO Internet access is required either + - Optional, GPU Acceleration is available in `llama.cpp`-compatible LLMs. See also the [build section](https://localai.io/basics/build/index.html). +- Supports multiple models: + - πŸ—£ Text to Audio πŸŽΊπŸ†• + - πŸ”ˆ Audio to Text (Audio transcription with `whisper.cpp`) + - πŸ“– Text generation with GPTs (`llama.cpp`, `gpt4all.cpp`, ... and more) + - 🎨 Image generation with stable diffusion +- πŸƒ Once loaded the first time, it keep models loaded in memory for faster inference +- ⚑ Doesn't shell-out, but uses C++ bindings for a faster inference and better performance. -LocalAI was created by [Ettore Di Giacinto](https://github.com/mudler/) and is a community-driven project, focused on making the AI accessible to anyone. Any contribution, feedback and PR is welcome! +LocalAI was created by [Ettore Di Giacinto](https://github.com/mudler/) and is a community-driven project, focused on making the AI accessible to anyone. Any contribution, feedback and PR is welcome! + +See the [Getting started](https://localai.io/basics/getting_started/index.html) and [examples](https://github.com/go-skynet/LocalAI/tree/master/examples/) sections to learn how to use LocalAI. For a list of curated models check out the [model gallery](https://localai.io/models/). -See the [examples](https://github.com/go-skynet/LocalAI/tree/master/examples/) on how to integrate LocalAI with other popular projects: | [ChatGPT OSS alternative](https://github.com/go-skynet/LocalAI/tree/master/examples/chatbot-ui) | [Image generation](https://localai.io/api-endpoints/index.html#image-generation) | |------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------| @@ -33,10 +41,9 @@ See the [examples](https://github.com/go-skynet/LocalAI/tree/master/examples/) o |------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------| ![Screenshot from 2023-06-09 00-36-26](https://github.com/go-skynet/LocalAI/assets/2420543/e98b4305-fa2d-41cf-9d2f-1bb2d75ca902) | ![Screenshot from 2023-05-30 18-01-03](https://github.com/go-skynet/LocalAI/assets/2420543/02458782-0549-4131-971c-95ee56ec1af8)| | -See the [Getting started](https://localai.io/basics/getting_started/index.html) and [examples](https://github.com/go-skynet/LocalAI/tree/master/examples/) sections to learn how to use LocalAI. For a list of curated models check out the [model gallery](https://localai.io/models/). - ## News +- πŸ”₯πŸ”₯πŸ”₯ 28-06-2023: **v1.20.0**: Added text to audio and gallery huggingface repositories! [Release notes](https://localai.io/basics/news/index.html#-28-06-2023-__v1200__-) [Changelog](https://github.com/go-skynet/LocalAI/releases/tag/v1.20.0) - πŸ”₯πŸ”₯πŸ”₯ 19-06-2023: **v1.19.0**: CUDA support! [Release notes](https://localai.io/basics/news/index.html#-19-06-2023-__v1190__-) [Changelog](https://github.com/go-skynet/LocalAI/releases/tag/v1.19.0) - πŸ”₯πŸ”₯πŸ”₯ 06-06-2023: **v1.18.0**: Many updates, new features, and much more πŸš€, check out the [Release notes](https://localai.io/basics/news/index.html#-06-06-2023-__v1180__-)! - 29-05-2023: LocalAI now has a website, [https://localai.io](https://localai.io)! check the news in the [dedicated section](https://localai.io/basics/news/index.html)! @@ -188,7 +195,10 @@ Feel free to open up a PR to get your project listed! - [x] Support for embeddings - [x] Support for audio transcription with https://github.com/ggerganov/whisper.cpp - [x] GPU/CUDA support ( https://github.com/go-skynet/LocalAI/issues/69 ) -- [ ] Enable automatic downloading of models from a curated gallery, with only free-licensed models, directly from the webui. +- [X] Enable automatic downloading of models from a curated gallery +- [ ] Enable automatic downloading of models from HuggingFace +- [ ] Enable gallery management directly from the webui. +- [ ] πŸ”₯ OpenAI functions: https://github.com/go-skynet/LocalAI/issues/588 ## Star history