eder0782 commited on
Commit
b9b47c4
·
verified ·
1 Parent(s): 7def60a

Delete README.md

Browse files
Files changed (1) hide show
  1. README.md +0 -222
README.md DELETED
@@ -1,222 +0,0 @@
1
- <h1 align="center">
2
- <br>
3
- <img height="300" src="https://github.com/go-skynet/LocalAI/assets/2420543/0966aa2a-166e-4f99-a3e5-6c915fc997dd"> <br>
4
- LocalAI
5
- <br>
6
- </h1>
7
-
8
- <p align="center">
9
- <a href="https://github.com/go-skynet/LocalAI/fork" target="blank">
10
- <img src="https://img.shields.io/github/forks/go-skynet/LocalAI?style=for-the-badge" alt="LocalAI forks"/>
11
- </a>
12
- <a href="https://github.com/go-skynet/LocalAI/stargazers" target="blank">
13
- <img src="https://img.shields.io/github/stars/go-skynet/LocalAI?style=for-the-badge" alt="LocalAI stars"/>
14
- </a>
15
- <a href="https://github.com/go-skynet/LocalAI/pulls" target="blank">
16
- <img src="https://img.shields.io/github/issues-pr/go-skynet/LocalAI?style=for-the-badge" alt="LocalAI pull-requests"/>
17
- </a>
18
- <a href='https://github.com/go-skynet/LocalAI/releases'>
19
- <img src='https://img.shields.io/github/release/go-skynet/LocalAI?&label=Latest&style=for-the-badge'>
20
- </a>
21
- </p>
22
-
23
- <p align="center">
24
- <a href="https://hub.docker.com/r/localai/localai" target="blank">
25
- <img src="https://img.shields.io/badge/dockerhub-images-important.svg?logo=Docker" alt="LocalAI Docker hub"/>
26
- </a>
27
- <a href="https://quay.io/repository/go-skynet/local-ai?tab=tags&tag=latest" target="blank">
28
- <img src="https://img.shields.io/badge/quay.io-images-important.svg?" alt="LocalAI Quay.io"/>
29
- </a>
30
- </p>
31
-
32
- <p align="center">
33
- <a href="https://twitter.com/LocalAI_API" target="blank">
34
- <img src="https://img.shields.io/twitter/follow/LocalAI_API?label=Follow: LocalAI_API&style=social" alt="Follow LocalAI_API"/>
35
- </a>
36
- <a href="https://discord.gg/uJAeKSAGDy" target="blank">
37
- <img src="https://dcbadge.vercel.app/api/server/uJAeKSAGDy?style=flat-square&theme=default-inverted" alt="Join LocalAI Discord Community"/>
38
- </a>
39
- </p>
40
-
41
- > :bulb: Get help - [❓FAQ](https://localai.io/faq/) [💭Discussions](https://github.com/go-skynet/LocalAI/discussions) [:speech_balloon: Discord](https://discord.gg/uJAeKSAGDy) [:book: Documentation website](https://localai.io/)
42
- >
43
- > [💻 Quickstart](https://localai.io/basics/getting_started/) [📣 News](https://localai.io/basics/news/) [ 🛫 Examples ](https://github.com/go-skynet/LocalAI/tree/master/examples/) [ 🖼️ Models ](https://localai.io/models/) [ 🚀 Roadmap ](https://github.com/mudler/LocalAI/issues?q=is%3Aissue+is%3Aopen+label%3Aroadmap)
44
-
45
- [![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)
46
-
47
- **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).
48
-
49
- ![screen](https://github.com/mudler/LocalAI/assets/2420543/20b5ccd2-8393-44f0-aaf6-87a23806381e)
50
-
51
- Run the installer script:
52
-
53
- ```bash
54
- curl https://localai.io/install.sh | sh
55
- ```
56
-
57
- Or run with docker:
58
- ```bash
59
- docker run -ti --name local-ai -p 8080:8080 localai/localai:latest-aio-cpu
60
- # Alternative images:
61
- # - if you have an Nvidia GPU:
62
- # docker run -ti --name local-ai -p 8080:8080 --gpus all localai/localai:latest-aio-gpu-nvidia-cuda-12
63
- # - without preconfigured models
64
- # docker run -ti --name local-ai -p 8080:8080 localai/localai:latest
65
- # - without preconfigured models for Nvidia GPUs
66
- # docker run -ti --name local-ai -p 8080:8080 --gpus all localai/localai:latest-gpu-nvidia-cuda-12
67
- ```
68
-
69
- [💻 Getting started](https://localai.io/basics/getting_started/index.html)
70
-
71
- ## 🔥🔥 Hot topics / Roadmap
72
-
73
- [Roadmap](https://github.com/mudler/LocalAI/issues?q=is%3Aissue+is%3Aopen+label%3Aroadmap)
74
-
75
- - July 2024: 🔥🔥 🆕 P2P Dashboard, LocalAI Federated mode and AI Swarms: https://github.com/mudler/LocalAI/pull/2723
76
- - June 2024: 🆕 You can browse now the model gallery without LocalAI! Check out https://models.localai.io
77
- - June 2024: Support for models from OCI registries: https://github.com/mudler/LocalAI/pull/2628
78
- - May 2024: 🔥🔥 Decentralized P2P llama.cpp: https://github.com/mudler/LocalAI/pull/2343 (peer2peer llama.cpp!) 👉 Docs https://localai.io/features/distribute/
79
- - May 2024: 🔥🔥 Openvoice: https://github.com/mudler/LocalAI/pull/2334
80
- - May 2024: 🆕 Function calls without grammars and mixed mode: https://github.com/mudler/LocalAI/pull/2328
81
- - May 2024: 🔥🔥 Distributed inferencing: https://github.com/mudler/LocalAI/pull/2324
82
- - May 2024: Chat, TTS, and Image generation in the WebUI: https://github.com/mudler/LocalAI/pull/2222
83
- - April 2024: Reranker API: https://github.com/mudler/LocalAI/pull/2121
84
-
85
- Hot topics (looking for contributors):
86
-
87
- - 🔥🔥 Distributed, P2P Global community pools: https://github.com/mudler/LocalAI/issues/3113
88
- - WebUI improvements: https://github.com/mudler/LocalAI/issues/2156
89
- - Backends v2: https://github.com/mudler/LocalAI/issues/1126
90
- - Improving UX v2: https://github.com/mudler/LocalAI/issues/1373
91
- - Assistant API: https://github.com/mudler/LocalAI/issues/1273
92
- - Moderation endpoint: https://github.com/mudler/LocalAI/issues/999
93
- - Vulkan: https://github.com/mudler/LocalAI/issues/1647
94
- - Anthropic API: https://github.com/mudler/LocalAI/issues/1808
95
-
96
- 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
97
-
98
- ## 🚀 [Features](https://localai.io/features/)
99
-
100
- - 📖 [Text generation with GPTs](https://localai.io/features/text-generation/) (`llama.cpp`, `gpt4all.cpp`, ... [:book: and more](https://localai.io/model-compatibility/index.html#model-compatibility-table))
101
- - 🗣 [Text to Audio](https://localai.io/features/text-to-audio/)
102
- - 🔈 [Audio to Text](https://localai.io/features/audio-to-text/) (Audio transcription with `whisper.cpp`)
103
- - 🎨 [Image generation with stable diffusion](https://localai.io/features/image-generation)
104
- - 🔥 [OpenAI-alike tools API](https://localai.io/features/openai-functions/)
105
- - 🧠 [Embeddings generation for vector databases](https://localai.io/features/embeddings/)
106
- - ✍️ [Constrained grammars](https://localai.io/features/constrained_grammars/)
107
- - 🖼️ [Download Models directly from Huggingface ](https://localai.io/models/)
108
- - 🥽 [Vision API](https://localai.io/features/gpt-vision/)
109
- - 📈 [Reranker API](https://localai.io/features/reranker/)
110
- - 🆕🖧 [P2P Inferencing](https://localai.io/features/distribute/)
111
- - 🌍 Integrated WebUI!
112
-
113
- ## 💻 Usage
114
-
115
- Check out the [Getting started](https://localai.io/basics/getting_started/index.html) section in our documentation.
116
-
117
- ### 🔗 Community and integrations
118
-
119
- Build and deploy custom containers:
120
- - https://github.com/sozercan/aikit
121
-
122
- WebUIs:
123
- - https://github.com/Jirubizu/localai-admin
124
- - https://github.com/go-skynet/LocalAI-frontend
125
- - QA-Pilot(An interactive chat project that leverages LocalAI LLMs for rapid understanding and navigation of GitHub code repository) https://github.com/reid41/QA-Pilot
126
-
127
- Model galleries
128
- - https://github.com/go-skynet/model-gallery
129
-
130
- Other:
131
- - Helm chart https://github.com/go-skynet/helm-charts
132
- - VSCode extension https://github.com/badgooooor/localai-vscode-plugin
133
- - Terminal utility https://github.com/djcopley/ShellOracle
134
- - Local Smart assistant https://github.com/mudler/LocalAGI
135
- - Home Assistant https://github.com/sammcj/homeassistant-localai / https://github.com/drndos/hass-openai-custom-conversation / https://github.com/valentinfrlch/ha-gpt4vision
136
- - Discord bot https://github.com/mudler/LocalAGI/tree/main/examples/discord
137
- - Slack bot https://github.com/mudler/LocalAGI/tree/main/examples/slack
138
- - Shell-Pilot(Interact with LLM using LocalAI models via pure shell scripts on your Linux or MacOS system) https://github.com/reid41/shell-pilot
139
- - Telegram bot https://github.com/mudler/LocalAI/tree/master/examples/telegram-bot
140
- - Github Actions: https://github.com/marketplace/actions/start-localai
141
- - Examples: https://github.com/mudler/LocalAI/tree/master/examples/
142
-
143
-
144
- ### 🔗 Resources
145
-
146
- - [LLM finetuning guide](https://localai.io/docs/advanced/fine-tuning/)
147
- - [How to build locally](https://localai.io/basics/build/index.html)
148
- - [How to install in Kubernetes](https://localai.io/basics/getting_started/index.html#run-localai-in-kubernetes)
149
- - [Projects integrating LocalAI](https://localai.io/docs/integrations/)
150
- - [How tos section](https://io.midori-ai.xyz/howtos/) (curated by our community)
151
-
152
- ## :book: 🎥 [Media, Blogs, Social](https://localai.io/basics/news/#media-blogs-social)
153
-
154
- - [Run Visual studio code with LocalAI (SUSE)](https://www.suse.com/c/running-ai-locally/)
155
- - 🆕 [Run LocalAI on Jetson Nano Devkit](https://mudler.pm/posts/local-ai-jetson-nano-devkit/)
156
- - [Run LocalAI on AWS EKS with Pulumi](https://www.pulumi.com/blog/low-code-llm-apps-with-local-ai-flowise-and-pulumi/)
157
- - [Run LocalAI on AWS](https://staleks.hashnode.dev/installing-localai-on-aws-ec2-instance)
158
- - [Create a slackbot for teams and OSS projects that answer to documentation](https://mudler.pm/posts/smart-slackbot-for-teams/)
159
- - [LocalAI meets k8sgpt](https://www.youtube.com/watch?v=PKrDNuJ_dfE)
160
- - [Question Answering on Documents locally with LangChain, LocalAI, Chroma, and GPT4All](https://mudler.pm/posts/localai-question-answering/)
161
- - [Tutorial to use k8sgpt with LocalAI](https://medium.com/@tyler_97636/k8sgpt-localai-unlock-kubernetes-superpowers-for-free-584790de9b65)
162
-
163
- ## Citation
164
-
165
- If you utilize this repository, data in a downstream project, please consider citing it with:
166
-
167
- ```
168
- @misc{localai,
169
- author = {Ettore Di Giacinto},
170
- title = {LocalAI: The free, Open source OpenAI alternative},
171
- year = {2023},
172
- publisher = {GitHub},
173
- journal = {GitHub repository},
174
- howpublished = {\url{https://github.com/go-skynet/LocalAI}},
175
- ```
176
-
177
- ## ❤️ Sponsors
178
-
179
- > Do you find LocalAI useful?
180
-
181
- Support the project by becoming [a backer or sponsor](https://github.com/sponsors/mudler). Your logo will show up here with a link to your website.
182
-
183
- A huge thank you to our generous sponsors who support this project covering CI expenses, and our [Sponsor list](https://github.com/sponsors/mudler):
184
-
185
- <p align="center">
186
- <a href="https://www.spectrocloud.com/" target="blank">
187
- <img height="200" src="https://github.com/go-skynet/LocalAI/assets/2420543/68a6f3cb-8a65-4a4d-99b5-6417a8905512">
188
- </a>
189
- <a href="https://www.premai.io/" target="blank">
190
- <img height="200" src="https://github.com/mudler/LocalAI/assets/2420543/42e4ca83-661e-4f79-8e46-ae43689683d6"> <br>
191
- </a>
192
- </p>
193
-
194
- ## 🌟 Star history
195
-
196
- [![LocalAI Star history Chart](https://api.star-history.com/svg?repos=go-skynet/LocalAI&type=Date)](https://star-history.com/#go-skynet/LocalAI&Date)
197
-
198
- ## 📖 License
199
-
200
- LocalAI is a community-driven project created by [Ettore Di Giacinto](https://github.com/mudler/).
201
-
202
- MIT - Author Ettore Di Giacinto <[email protected]>
203
-
204
- ## 🙇 Acknowledgements
205
-
206
- LocalAI couldn't have been built without the help of great software already available from the community. Thank you!
207
-
208
- - [llama.cpp](https://github.com/ggerganov/llama.cpp)
209
- - https://github.com/tatsu-lab/stanford_alpaca
210
- - https://github.com/cornelk/llama-go for the initial ideas
211
- - https://github.com/antimatter15/alpaca.cpp
212
- - https://github.com/EdVince/Stable-Diffusion-NCNN
213
- - https://github.com/ggerganov/whisper.cpp
214
- - https://github.com/saharNooby/rwkv.cpp
215
- - https://github.com/rhasspy/piper
216
-
217
- ## 🤗 Contributors
218
-
219
- This is a community project, a special thanks to our contributors! 🤗
220
- <a href="https://github.com/go-skynet/LocalAI/graphs/contributors">
221
- <img src="https://contrib.rocks/image?repo=go-skynet/LocalAI" />
222
- </a>