docs/examples: enhancements #1572

mudler · 2024-01-10T17:49:11Z

Description

Related to #1373, as this is still an effort of ease usage. This is also a follow-up of #1556. I'm planning to add missing examples here.

For models, I think it's a good metric what I've seen in https://twitter.com/gblazex/status/1744602366798594150 - so I'll add the models for those in that list.

Fixes #1561. Related to: #1373 #1031 #1416

Notes for Reviewers

Also adds documentation around #1561

cc @chris-hatton @apstrom

Signed commits

Yes, I signed my commits.

netlify · 2024-01-10T17:49:15Z

✅ Deploy Preview for localai ready!

Name	Link
🔨 Latest commit	`0cc6e93`
🔍 Latest deploy log	https://app.netlify.com/sites/localai/deploys/65a9703504f31c00085818d9
😎 Deploy Preview	https://deploy-preview-1572--localai.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

mudler · 2024-01-11T18:42:46Z

Currently evaluating if switching docs to https://themes.gohugo.io/themes/lotusdocs/ or https://themes.gohugo.io/themes/amethyst/ .

I tend to like lotusdocs a bit more

mudler · 2024-01-13T09:14:12Z

cc @chris-hatton @apstrom I'd be happy (and would be really appreciated) to get your thoughts in here once this is ready for review

apstrom · 2024-01-14T01:37:08Z

cc @chris-hatton @apstrom I'd be happy (and would be really appreciated) to get your thoughts in here once this is ready for review

I am more than happy to help. I am using LocalAI as a base to set up my firm's in-house LLMs and GPTs. When I have time, I can help draft some of these documents to explain things like YAML configuration, initial setup, etc.

lunamidori5 · 2024-01-15T12:42:43Z

@mudler on the quickstart page, I have made a program that both sets up the docker image, and sets up a model, if you want to put that at the top somewhere under docker desktop.

https://io.midori-ai.xyz/howtos/easy-localai-installer/
https://io.midori-ai.xyz/howtos/easy-model-installer/

Both are super easy to run on OS like Windows and does all of the work for the end user!

lunamidori5 · 2024-01-15T12:43:58Z

Or we could make a intergr page for them

Signed-off-by: Ettore Di Giacinto <mudler@localai.io>

Signed-off-by: lunamidori5 <118759930+lunamidori5@users.noreply.github.com>

mudler · 2024-01-18T18:36:23Z

ready to merge, and it already took enough of my time.. changes to it can be done later on!

….0 by renovate (#17442) This PR contains the following updates: | Package | Update | Change | |---|---|---| | [docker.io/localai/localai](https://togithub.com/mudler/LocalAI) | minor | `v2.5.1-cublas-cuda11-ffmpeg-core` -> `v2.6.0-cublas-cuda11-ffmpeg-core` | --- > [!WARNING] > Some dependencies could not be looked up. Check the Dependency Dashboard for more information. --- ### Release Notes <details> <summary>mudler/LocalAI (docker.io/localai/localai)</summary> ### [`v2.6.0`](https://togithub.com/mudler/LocalAI/releases/tag/v2.6.0) [Compare Source](https://togithub.com/mudler/LocalAI/compare/v2.5.1...v2.6.0)  ##### What's Changed ##### Bug fixes 🐛 - move BUILD_GRPC_FOR_BACKEND_LLAMA logic to makefile: errors in this section now immediately fail the build by [@dionysius](https://togithub.com/dionysius) in [mudler/LocalAI#1576 - prepend built binaries in PATH for BUILD_GRPC_FOR_BACKEND_LLAMA by [@dionysius](https://togithub.com/dionysius) in [mudler/LocalAI#1593 ##### Exciting New Features 🎉 - minor: replace shell pwd in Makefile with CURDIR for better windows compatibility by [@dionysius](https://togithub.com/dionysius) in [mudler/LocalAI#1571 - Makefile: allow to build without GRPC_BACKENDS by [@mudler](https://togithub.com/mudler) in [mudler/LocalAI#1607 - feat: 🐍 add mamba support by [@mudler](https://togithub.com/mudler) in [mudler/LocalAI#1589 - feat(extra-backends): Improvements, adding mamba example by [@mudler](https://togithub.com/mudler) in [mudler/LocalAI#1618 ##### 👒 Dependencies - ⬆️ Update docs version mudler/LocalAI by [@localai-bot](https://togithub.com/localai-bot) in [mudler/LocalAI#1567 - ⬆️ Update ggerganov/llama.cpp by [@localai-bot](https://togithub.com/localai-bot) in [mudler/LocalAI#1568 - ⬆️ Update ggerganov/llama.cpp by [@localai-bot](https://togithub.com/localai-bot) in [mudler/LocalAI#1573 - ⬆️ Update ggerganov/llama.cpp by [@localai-bot](https://togithub.com/localai-bot) in [mudler/LocalAI#1578 - ⬆️ Update ggerganov/llama.cpp by [@localai-bot](https://togithub.com/localai-bot) in [mudler/LocalAI#1583 - ⬆️ Update ggerganov/llama.cpp by [@localai-bot](https://togithub.com/localai-bot) in [mudler/LocalAI#1587 - ⬆️ Update ggerganov/llama.cpp by [@localai-bot](https://togithub.com/localai-bot) in [mudler/LocalAI#1590 - ⬆️ Update ggerganov/llama.cpp by [@localai-bot](https://togithub.com/localai-bot) in [mudler/LocalAI#1594 - ⬆️ Update ggerganov/llama.cpp by [@localai-bot](https://togithub.com/localai-bot) in [mudler/LocalAI#1599 ##### Other Changes - Moving the how tos to self hosted by [@lunamidori5](https://togithub.com/lunamidori5) in [mudler/LocalAI#1574 - docs: missing golang requirement for local build for debian by [@dionysius](https://togithub.com/dionysius) in [mudler/LocalAI#1596 - ⬆️ Update ggerganov/llama.cpp by [@localai-bot](https://togithub.com/localai-bot) in [mudler/LocalAI#1597 - docs/examples: enhancements by [@mudler](https://togithub.com/mudler) in [mudler/LocalAI#1572 - ⬆️ Update ggerganov/llama.cpp by [@localai-bot](https://togithub.com/localai-bot) in [mudler/LocalAI#1604 - Update README.md by [@lunamidori5](https://togithub.com/lunamidori5) in [mudler/LocalAI#1601 - docs: re-use original permalinks by [@mudler](https://togithub.com/mudler) in [mudler/LocalAI#1610 - ⬆️ Update ggerganov/llama.cpp by [@localai-bot](https://togithub.com/localai-bot) in [mudler/LocalAI#1612 - Expanded and interlinked Docker documentation by [@jamesbraza](https://togithub.com/jamesbraza) in [mudler/LocalAI#1614 - Modernized LlamaIndex integration by [@jamesbraza](https://togithub.com/jamesbraza) in [mudler/LocalAI#1613 ##### New Contributors - [@dionysius](https://togithub.com/dionysius) made their first contribution in [mudler/LocalAI#1571 **Full Changelog**: mudler/LocalAI@v2.5.1...v2.6.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "before 10pm on monday" in timezone Europe/Amsterdam, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://togithub.com/renovatebot/renovate).

….0 by renovate (truecharts#17442) This PR contains the following updates: | Package | Update | Change | |---|---|---| | [docker.io/localai/localai](https://togithub.com/mudler/LocalAI) | minor | `v2.5.1-cublas-cuda11-ffmpeg-core` -> `v2.6.0-cublas-cuda11-ffmpeg-core` | --- > [!WARNING] > Some dependencies could not be looked up. Check the Dependency Dashboard for more information. --- ### Release Notes <details> <summary>mudler/LocalAI (docker.io/localai/localai)</summary> ### [`v2.6.0`](https://togithub.com/mudler/LocalAI/releases/tag/v2.6.0) [Compare Source](https://togithub.com/mudler/LocalAI/compare/v2.5.1...v2.6.0)  ##### What's Changed ##### Bug fixes 🐛 - move BUILD_GRPC_FOR_BACKEND_LLAMA logic to makefile: errors in this section now immediately fail the build by [@&truecharts#8203;dionysius](https://togithub.com/dionysius) in [mudler/LocalAI#1576 - prepend built binaries in PATH for BUILD_GRPC_FOR_BACKEND_LLAMA by [@&truecharts#8203;dionysius](https://togithub.com/dionysius) in [mudler/LocalAI#1593 ##### Exciting New Features 🎉 - minor: replace shell pwd in Makefile with CURDIR for better windows compatibility by [@&truecharts#8203;dionysius](https://togithub.com/dionysius) in [mudler/LocalAI#1571 - Makefile: allow to build without GRPC_BACKENDS by [@&truecharts#8203;mudler](https://togithub.com/mudler) in [mudler/LocalAI#1607 - feat: 🐍 add mamba support by [@&truecharts#8203;mudler](https://togithub.com/mudler) in [mudler/LocalAI#1589 - feat(extra-backends): Improvements, adding mamba example by [@&truecharts#8203;mudler](https://togithub.com/mudler) in [mudler/LocalAI#1618 ##### 👒 Dependencies - ⬆️ Update docs version mudler/LocalAI by [@&truecharts#8203;localai-bot](https://togithub.com/localai-bot) in [mudler/LocalAI#1567 - ⬆️ Update ggerganov/llama.cpp by [@&truecharts#8203;localai-bot](https://togithub.com/localai-bot) in [mudler/LocalAI#1568 - ⬆️ Update ggerganov/llama.cpp by [@&truecharts#8203;localai-bot](https://togithub.com/localai-bot) in [mudler/LocalAI#1573 - ⬆️ Update ggerganov/llama.cpp by [@&truecharts#8203;localai-bot](https://togithub.com/localai-bot) in [mudler/LocalAI#1578 - ⬆️ Update ggerganov/llama.cpp by [@&truecharts#8203;localai-bot](https://togithub.com/localai-bot) in [mudler/LocalAI#1583 - ⬆️ Update ggerganov/llama.cpp by [@&truecharts#8203;localai-bot](https://togithub.com/localai-bot) in [mudler/LocalAI#1587 - ⬆️ Update ggerganov/llama.cpp by [@&truecharts#8203;localai-bot](https://togithub.com/localai-bot) in [mudler/LocalAI#1590 - ⬆️ Update ggerganov/llama.cpp by [@&truecharts#8203;localai-bot](https://togithub.com/localai-bot) in [mudler/LocalAI#1594 - ⬆️ Update ggerganov/llama.cpp by [@&truecharts#8203;localai-bot](https://togithub.com/localai-bot) in [mudler/LocalAI#1599 ##### Other Changes - Moving the how tos to self hosted by [@&truecharts#8203;lunamidori5](https://togithub.com/lunamidori5) in [mudler/LocalAI#1574 - docs: missing golang requirement for local build for debian by [@&truecharts#8203;dionysius](https://togithub.com/dionysius) in [mudler/LocalAI#1596 - ⬆️ Update ggerganov/llama.cpp by [@&truecharts#8203;localai-bot](https://togithub.com/localai-bot) in [mudler/LocalAI#1597 - docs/examples: enhancements by [@&truecharts#8203;mudler](https://togithub.com/mudler) in [mudler/LocalAI#1572 - ⬆️ Update ggerganov/llama.cpp by [@&truecharts#8203;localai-bot](https://togithub.com/localai-bot) in [mudler/LocalAI#1604 - Update README.md by [@&truecharts#8203;lunamidori5](https://togithub.com/lunamidori5) in [mudler/LocalAI#1601 - docs: re-use original permalinks by [@&truecharts#8203;mudler](https://togithub.com/mudler) in [mudler/LocalAI#1610 - ⬆️ Update ggerganov/llama.cpp by [@&truecharts#8203;localai-bot](https://togithub.com/localai-bot) in [mudler/LocalAI#1612 - Expanded and interlinked Docker documentation by [@&truecharts#8203;jamesbraza](https://togithub.com/jamesbraza) in [mudler/LocalAI#1614 - Modernized LlamaIndex integration by [@&truecharts#8203;jamesbraza](https://togithub.com/jamesbraza) in [mudler/LocalAI#1613 ##### New Contributors - [@&truecharts#8203;dionysius](https://togithub.com/dionysius) made their first contribution in [mudler/LocalAI#1571 **Full Changelog**: mudler/LocalAI@v2.5.1...v2.6.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "before 10pm on monday" in timezone Europe/Amsterdam, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://togithub.com/renovatebot/renovate).

mudler changed the title ~~docs: enhancements~~ docs/examples: enhancements Jan 10, 2024

mudler mentioned this pull request Jan 10, 2024

vvlm not found as backend after localai is built locally #1561

Closed

mudler force-pushed the docs_enhancements branch from 194b6fe to 30c9380 Compare January 11, 2024 18:20

mudler force-pushed the docs_enhancements branch 2 times, most recently from 213221a to 60dd190 Compare January 12, 2024 19:13

mudler force-pushed the docs_enhancements branch 3 times, most recently from 209bbba to d4193aa Compare January 13, 2024 17:58

mudler force-pushed the docs_enhancements branch 3 times, most recently from ff77905 to cef86e3 Compare January 14, 2024 18:57

mudler and others added 13 commits January 17, 2024 09:27

docs: re-order sections

3bd074b

fix references

cbb538c

Add mixtral-instruct, tinyllama-chat, dolphin-2.5-mixtral-8x7b

9e909bf

Fix link

5721c98

Minor corrections

e8658d4

fix: models is a StringSlice, not a String

8335450

Signed-off-by: Ettore Di Giacinto <mudler@localai.io>

WIP: switch docs theme

b4b8cd3

content

0391a03

Fix GH link

a5b0b69

enhancements

efd5cca

enhancements

e5ed5a5

Fixed how to link

e95121a

Signed-off-by: lunamidori5 <118759930+lunamidori5@users.noreply.github.com>

fixups

820d08a

logo fix

5fa6b2f

mudler force-pushed the docs_enhancements branch from f4c01e6 to 5fa6b2f Compare January 17, 2024 18:29

more fixups

361935e

mudler marked this pull request as ready for review January 18, 2024 18:35

final touches

0cc6e93

mudler force-pushed the docs_enhancements branch from 19baee2 to 0cc6e93 Compare January 18, 2024 18:38

mudler merged commit 6ca4d38 into master Jan 18, 2024
21 of 24 checks passed

mudler deleted the docs_enhancements branch January 18, 2024 18:41

mudler added the kind/documentation Improvements or additions to documentation label Jan 20, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs/examples: enhancements #1572

docs/examples: enhancements #1572

mudler commented Jan 10, 2024 •

edited

Loading

netlify bot commented Jan 10, 2024 •

edited

Loading

mudler commented Jan 11, 2024 •

edited

Loading

mudler commented Jan 13, 2024

apstrom commented Jan 14, 2024

lunamidori5 commented Jan 15, 2024

lunamidori5 commented Jan 15, 2024

mudler commented Jan 18, 2024 •

edited

Loading

docs/examples: enhancements #1572

docs/examples: enhancements #1572

Conversation

mudler commented Jan 10, 2024 • edited Loading

netlify bot commented Jan 10, 2024 • edited Loading

✅ Deploy Preview for localai ready!

mudler commented Jan 11, 2024 • edited Loading

mudler commented Jan 13, 2024

apstrom commented Jan 14, 2024

lunamidori5 commented Jan 15, 2024

lunamidori5 commented Jan 15, 2024

mudler commented Jan 18, 2024 • edited Loading

mudler commented Jan 10, 2024 •

edited

Loading

netlify bot commented Jan 10, 2024 •

edited

Loading

mudler commented Jan 11, 2024 •

edited

Loading

mudler commented Jan 18, 2024 •

edited

Loading