Configuring .gitignore so examples/chatbot-ui-manual/models doesn't show in git status

[jamesbraza]

When I make this repo a git submodule and then download a GGUF model to examples/chatbot-ui-manual/models, it shows up in my git status:

 ~/code/repo/LocalAI | on master > git status
On branch master
Your branch is up to date with 'origin/master'.

Untracked files:
  (use "git add <file>..." to include in what will be committed)
	examples/chatbot-ui-manual/models/llama-2-13b-chat.Q4_K_S.gguf

Can we configure this repo's .gitignore such that adding models to examples/xyz/models doesn't lead to a dirty git status?

[jamesbraza]

Looks like examples/slack-bot uses a symlink to models/ to solve this problem. It may be simplest to use the same symlink strategy in examples/chatbot-ui/chatbot-ui-manual

[localai-bot]

⚠️⚠️⚠️⚠️⚠️

Hi! I'm a bot running with LocalAI ( a crazy experiment of @mudler ) - please beware that I might hallucinate sometimes!

but.... I can also be funny or helpful 😸 and I can provide generally speaking good tips or places where to look after in the documentation or in the code based on what you wrote in the issue.

Don't engage in conversation with me,
I don't support (yet) replying!

⚠️⚠️⚠️⚠️⚠️

Yes, you can add the path to the models directory in your .gitignore file to exclude it from being tracked by Git. Here is an example of what your .gitignore file could look like:

# Ignore all files and directories in /examples/ except for the build directory
/examples/*
! /examples/build
# Ignore models directory
models/

This will exclude all files and directories in the /examples/ directory except for the build directory, and also specifically exclude the models directory. This should ensure that adding a model to the models directory does not show up as untracked in your git status.

Sources:

• https://localai.io/models/index.html
• https://github.com/go-skynet/LocalAI/tree/master/examples/slack-bot/README.md
• https://github.com/go-skynet/LocalAI/tree/master/.github/workflows/bump_deps.yaml
• https://github.com/go-skynet/LocalAI/tree/master/Makefile

[jamesbraza]

Thank you @localai-bot, though Ideally the default of the .gitignore just works, no need to manually tweak it.

[Aisuko]

Hi @jamesbraza According to your comment. It looks like there is no issue. I'm going to close this issue now.

[jamesbraza]

@Aisuko I think you misinterpreted my response to the bot, this issue persists. Can you reopen this?

This issue was about making the .gitignore apply to any models/ directory in the repo

[jamesbraza]

@Aisuko opened a PR that will resolve this now, thanks for reopening!