Skip to content

Commit f4cff1d

Browse files
committed
docs: update news
1 parent 6eda2e5 commit f4cff1d

File tree

2 files changed

+12
-91
lines changed

2 files changed

+12
-91
lines changed

README.md

+7-47
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,6 @@
2626
2727
[![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)
2828

29-
**LocalAI** is the free, Open Source OpenAI alternative. LocalAI act as a drop-in replacement REST API that’s compatible with OpenAI API specifications for local 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.
30-
31-
<p align="center"><b>Follow LocalAI </b></p>
32-
3329
<p align="center">
3430
<a href="https://twitter.com/LocalAI_API" target="blank">
3531
<img src="https://img.shields.io/twitter/follow/LocalAI_API?label=Follow: LocalAI_API&style=social" alt="Follow LocalAI_API"/>
@@ -38,61 +34,25 @@
3834
<img src="https://dcbadge.vercel.app/api/server/uJAeKSAGDy?style=flat-square&theme=default-inverted" alt="Join LocalAI Discord Community"/>
3935
</a>
4036

41-
<p align="center"><b>Connect with the Creator </b></p>
42-
43-
<p align="center">
44-
<a href="https://twitter.com/mudler_it" target="blank">
45-
<img src="https://img.shields.io/twitter/follow/mudler_it?label=Follow: mudler_it&style=social" alt="Follow mudler_it"/>
46-
</a>
47-
<a href='https://github.com/mudler'>
48-
<img alt="Follow on Github" src="https://img.shields.io/badge/Follow-mudler-black?logo=github&link=https%3A%2F%2Fgithub.heygears.com%2Fmudler">
49-
</a>
50-
</p>
51-
52-
<p align="center"><b>Share LocalAI Repository</b></p>
53-
54-
<p align="center">
55-
56-
<a href="https://twitter.com/intent/tweet?text=Check%20this%20GitHub%20repository%20out.%20LocalAI%20-%20Let%27s%20you%20easily%20run%20LLM%20locally.&url=https://github.com/go-skynet/LocalAI&hashtags=LocalAI,AI" target="blank">
57-
<img src="https://img.shields.io/twitter/follow/_LocalAI?label=Share Repo on Twitter&style=social" alt="Follow _LocalAI"/></a>
58-
<a href="https://t.me/share/url?text=Check%20this%20GitHub%20repository%20out.%20LocalAI%20-%20Let%27s%20you%20easily%20run%20LLM%20locally.&url=https://github.com/go-skynet/LocalAI" target="_blank"><img src="https://img.shields.io/twitter/url?label=Telegram&logo=Telegram&style=social&url=https://github.com/go-skynet/LocalAI" alt="Share on Telegram"/></a>
59-
<a href="https://api.whatsapp.com/send?text=Check%20this%20GitHub%20repository%20out.%20LocalAI%20-%20Let%27s%20you%20easily%20run%20LLM%20locally.%20https://github.com/go-skynet/LocalAI"><img src="https://img.shields.io/twitter/url?label=whatsapp&logo=whatsapp&style=social&url=https://github.com/go-skynet/LocalAI" /></a> <a href="https://www.reddit.com/submit?url=https://github.com/go-skynet/LocalAI&title=Check%20this%20GitHub%20repository%20out.%20LocalAI%20-%20Let%27s%20you%20easily%20run%20LLM%20locally.
60-
" target="blank">
61-
<img src="https://img.shields.io/twitter/url?label=Reddit&logo=Reddit&style=social&url=https://github.com/go-skynet/LocalAI" alt="Share on Reddit"/>
62-
</a> <a href="mailto:?subject=Check%20this%20GitHub%20repository%20out.%20LocalAI%20-%20Let%27s%20you%20easily%20run%20LLM%20locally.%3A%0Ahttps://github.com/go-skynet/LocalAI" target="_blank"><img src="https://img.shields.io/twitter/url?label=Gmail&logo=Gmail&style=social&url=https://github.com/go-skynet/LocalAI"/></a> <a href="https://www.buymeacoffee.com/mudler" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="23" width="100" style="border-radius:1px"></a>
63-
64-
</p>
65-
66-
## 💻 [Getting started](https://localai.io/basics/getting_started/index.html)
37+
**LocalAI** is the free, Open Source OpenAI alternative. LocalAI act as a drop-in replacement REST API that’s compatible with OpenAI API specifications for local 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.
6738

6839
## 🔥🔥 Hot topics / Roadmap
6940

7041
[Roadmap](https://github.com/mudler/LocalAI/issues?q=is%3Aissue+is%3Aopen+label%3Aroadmap)
7142

72-
🆕 New! [LLM finetuning guide](https://localai.io/advanced/fine-tuning/)
43+
- 🐸 Coqui: https://github.com/mudler/LocalAI/pull/1489
44+
- Inline templates: https://github.com/mudler/LocalAI/pull/1452
45+
- Mixtral: https://github.com/mudler/LocalAI/pull/1449
46+
- Img2vid https://github.com/mudler/LocalAI/pull/1442
47+
- Musicgen https://github.com/mudler/LocalAI/pull/1387
7348

7449
Hot topics (looking for contributors):
7550
- Backends v2: https://github.com/mudler/LocalAI/issues/1126
7651
- Improving UX v2: https://github.com/mudler/LocalAI/issues/1373
7752

7853
If you want to help and contribute, issues up for grabs: https://github.com/mudler/LocalAI/issues?q=is%3Aissue+is%3Aopen+label%3A%22up+for+grabs%22
7954

80-
81-
82-
<hr>
83-
84-
In a nutshell:
85-
86-
- Local, OpenAI drop-in alternative REST API. You own your data.
87-
- NO GPU required. NO Internet access is required either
88-
- Optional, GPU Acceleration is available in `llama.cpp`-compatible LLMs. See also the [build section](https://localai.io/basics/build/index.html).
89-
- Supports multiple models
90-
- 🏃 Once loaded the first time, it keep models loaded in memory for faster inference
91-
- ⚡ Doesn't shell-out, but uses C++ bindings for a faster inference and better performance.
92-
93-
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!
94-
95-
Note that this started just as a [fun weekend project](https://localai.io/#backstory) in order to try to create the necessary pieces for a full AI assistant like `ChatGPT`: the community is growing fast and we are working hard to make it better and more stable. If you want to help, please consider contributing (see below)!
55+
## 💻 [Getting started](https://localai.io/basics/getting_started/index.html)
9656

9757
## 🚀 [Features](https://localai.io/features/)
9858

docs/content/_index.en.md

+5-44
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,6 @@ title = "LocalAI"
2424
2525
**LocalAI** is the free, Open Source OpenAI alternative. LocalAI act as a drop-in replacement REST API that's compatible with OpenAI API specifications for local 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 that are compatible with the ggml format. Does not require GPU. It is maintained by [mudler](https://github.com/mudler).
2626

27-
<p align="center"><b>Follow LocalAI </b></p>
28-
2927
<p align="center">
3028
<a href="https://twitter.com/LocalAI_API" target="blank">
3129
<img src="https://img.shields.io/twitter/follow/LocalAI_API?label=Follow: LocalAI_API&style=social" alt="Follow LocalAI_API"/>
@@ -34,33 +32,6 @@ title = "LocalAI"
3432
<img src="https://dcbadge.vercel.app/api/server/uJAeKSAGDy?style=flat-square&theme=default-inverted" alt="Join LocalAI Discord Community"/>
3533
</a>
3634

37-
<p align="center"><b>Connect with the Creator </b></p>
38-
39-
<p align="center">
40-
<a href="https://twitter.com/mudler_it" target="blank">
41-
<img src="https://img.shields.io/twitter/follow/mudler_it?label=Follow: mudler_it&style=social" alt="Follow mudler_it"/>
42-
</a>
43-
<a href='https://github.com/mudler'>
44-
<img alt="Follow on Github" src="https://img.shields.io/badge/Follow-mudler-black?logo=github&link=https%3A%2F%2Fgithub.heygears.com%2Fmudler">
45-
</a>
46-
</p>
47-
48-
<p align="center"><b>Share LocalAI Repository</b></p>
49-
50-
<p align="center">
51-
52-
<a href="https://twitter.com/intent/tweet?text=Check%20this%20GitHub%20repository%20out.%20LocalAI%20-%20Let%27s%20you%20easily%20run%20LLM%20locally.&url=https://github.com/go-skynet/LocalAI&hashtags=LocalAI,AI" target="blank">
53-
<img src="https://img.shields.io/twitter/follow/_LocalAI?label=Share Repo on Twitter&style=social" alt="Follow _LocalAI"/></a>
54-
<a href="https://t.me/share/url?text=Check%20this%20GitHub%20repository%20out.%20LocalAI%20-%20Let%27s%20you%20easily%20run%20LLM%20locally.&url=https://github.com/go-skynet/LocalAI" target="_blank"><img src="https://img.shields.io/twitter/url?label=Telegram&logo=Telegram&style=social&url=https://github.com/go-skynet/LocalAI" alt="Share on Telegram"/></a>
55-
<a href="https://api.whatsapp.com/send?text=Check%20this%20GitHub%20repository%20out.%20LocalAI%20-%20Let%27s%20you%20easily%20run%20LLM%20locally.%20https://github.com/go-skynet/LocalAI"><img src="https://img.shields.io/twitter/url?label=whatsapp&logo=whatsapp&style=social&url=https://github.com/go-skynet/LocalAI" /></a> <a href="https://www.reddit.com/submit?url=https://github.com/go-skynet/LocalAI&title=Check%20this%20GitHub%20repository%20out.%20LocalAI%20-%20Let%27s%20you%20easily%20run%20LLM%20locally.
56-
" target="blank">
57-
<img src="https://img.shields.io/twitter/url?label=Reddit&logo=Reddit&style=social&url=https://github.com/go-skynet/LocalAI" alt="Share on Reddit"/>
58-
</a> <a href="mailto:?subject=Check%20this%20GitHub%20repository%20out.%20LocalAI%20-%20Let%27s%20you%20easily%20run%20LLM%20locally.%3A%0Ahttps://github.com/go-skynet/LocalAI" target="_blank"><img src="https://img.shields.io/twitter/url?label=Gmail&logo=Gmail&style=social&url=https://github.com/go-skynet/LocalAI"/></a> <a href="https://www.buymeacoffee.com/mudler" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="23" width="100" style="border-radius:1px"></a>
59-
60-
</p>
61-
62-
<hr>
63-
6435
In a nutshell:
6536

6637
- Local, OpenAI drop-in alternative REST API. You own your data.
@@ -70,9 +41,10 @@ In a nutshell:
7041
- 🏃 Once loaded the first time, it keep models loaded in memory for faster inference
7142
- ⚡ Doesn't shell-out, but uses C++ bindings for a faster inference and better performance.
7243

73-
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!
44+
LocalAI is focused on making the AI accessible to anyone. Any contribution, feedback and PR is welcome!
45+
46+
Note that this started just as a fun weekend project by [mudler](https://github.com/mudler) in order to try to create the necessary pieces for a full AI assistant like `ChatGPT`: the community is growing fast and we are working hard to make it better and more stable. If you want to help, please consider contributing (see below)!
7447

75-
Note that this started just as a [fun weekend project](https://localai.io/#backstory) in order to try to create the necessary pieces for a full AI assistant like `ChatGPT`: the community is growing fast and we are working hard to make it better and more stable. If you want to help, please consider contributing (see below)!
7648

7749
## 🚀 Features
7850

@@ -86,19 +58,6 @@ Note that this started just as a [fun weekend project](https://localai.io/#backs
8658
- 🖼️ [Download Models directly from Huggingface ](https://localai.io/models/)
8759
- 🆕 [Vision API](https://localai.io/features/gpt-vision/)
8860

89-
90-
## 🔥🔥 Hot topics / Roadmap
91-
92-
[Roadmap](https://github.com/mudler/LocalAI/issues?q=is%3Aissue+is%3Aopen+label%3Aroadmap)
93-
94-
🆕 New! [LLM finetuning guide](https://localai.io/advanced/fine-tuning/)
95-
96-
Hot topics (looking for contributors):
97-
- Backends v2: https://github.com/mudler/LocalAI/issues/1126
98-
- Improving UX v2: https://github.com/mudler/LocalAI/issues/1373
99-
100-
If you want to help and contribute, issues up for grabs: https://github.com/mudler/LocalAI/issues?q=is%3Aissue+is%3Aopen+label%3A%22up+for+grabs%22
101-
10261
## How does it work?
10362

10463
LocalAI is an API written in Go that serves as an OpenAI shim, enabling software already developed with OpenAI SDKs to seamlessly integrate with LocalAI. It can be effortlessly implemented as a substitute, even on consumer-grade hardware. This capability is achieved by employing various C++ backends, including [ggml](https://github.com/ggerganov/ggml), to perform inference on LLMs using both CPU and, if desired, GPU. Internally LocalAI backends are just gRPC server, indeed you can specify and build your own gRPC server and extend LocalAI in runtime as well. It is possible to specify external gRPC server and/or binaries that LocalAI will manage internally.
@@ -139,6 +98,8 @@ LocalAI couldn't have been built without the help of great software already avai
13998
- https://github.com/rhasspy/piper
14099
- https://github.com/cmp-nct/ggllm.cpp
141100

101+
102+
142103
## Backstory
143104

144105
As much as typical open source projects starts, I, [mudler](https://github.com/mudler/), was fiddling around with [llama.cpp](https://github.com/ggerganov/llama.cpp) over my long nights and wanted to have a way to call it from `go`, as I am a Golang developer and use it extensively. So I've created `LocalAI` (or what was initially known as `llama-cli`) and added an API to it.

0 commit comments

Comments
 (0)