search

mudler / LocalAI

:robot: The free, Open Source alternative to OpenAI, Claude and others. Self-hosted and local-first. Drop-in replacement for OpenAI, running on consumer-grade hardware. No GPU required. Runs gguf, transformers, diffusers and many more models architectures. Features: Generate Text, Audio, Video, Images, Voice Cloning, Distributed, P2P inference
https://localai.io
MIT License
26.49k stars 1.98k forks source link

Incorrect version causing formatting issue in docs #2162

Closed linuxtek-canada closed 7 months ago

linuxtek-canada commented 7 months ago

LocalAI version: v2.13.0

Environment, CPU architecture, OS, and Version: N/A - Docs Issue

Describe the bug The current version being used in the OpenAI Docs is "🖼️ v2.13.0 - Model gallery edition". This is being pulled from: https://github.com/mudler/LocalAI/blob/master/docs/data/version.json

The docs use a {{< version >}} dynamic value referencing the above json file.

This is causing all the Docker commands to have the emoji and incorrect values in them here: https://localai.io/docs/getting-started/run-other-models/

To Reproduce Copy the Docker command from the Run Other Models Docs page, and attempt to run it. You will get this error:

docker run -ti -p 8080:8080 localai/localai: :frame_photo: v2.13.0 - Model gallery edition-ffmpeg-core phi-2
docker: invalid reference format.
See 'docker run --help'.

Expected behavior Correct Docker syntax with proper image names and tags to pull the image properly.

Logs N/A

Additional context Based on the file history, the version should just be v2.13.0.

linuxtek-canada commented 7 months ago

I can work on fixing this tomorrow.

localai-bot commented 7 months ago

Hello, thank you for reporting the issue with the version in the documentation. I'm a bot, an experiment of @mudler, that audits the tickets opened in this Github project.

I understand that you've found an incorrect version causing a formatting issue in the Docs of LocalAI. The version being used in the OpenAI Docs is "🖼️ v2.13.0 - Model gallery edition", which is pulled from the version.json file. This is causing incorrect Docker commands to appear in the documentation, resulting in errors when attempting to run the copied commands.

To reproduce the issue, one would copy a Docker command from the "Run Other Models" Docs page and try to run it, resulting in a "docker: invalid reference format" error. The expected behavior is correct Docker syntax with proper image names and tags.

Based on the file history of version.json, it seems that the version should just be v2.13.0, and not the emojified version as displayed in the Docs.

To resolve this issue, I suggest updating the version.json file to use the correct format, removing the emoji and unwanted suffix. Once updated, the Docker commands in the documentation should display the correct syntax and work as expected.

Please let me know if you have any other concerns or issues. Thanks for helping us improve LocalAI!

debjit commented 7 months ago

Thanks @linuxtek-canada for raising this issue. https://discord.com/channels/1096914990004457512/1233965318100094996/1233965325851168799

linuxtek-canada commented 7 months ago

This is fixed via this commit: https://github.com/mudler/LocalAI/commit/3179c019af17a7fdede8089eaa410359ca151d74

Confirmed the website is already corrected.