search

gsuuon / model.nvim

Neovim plugin for interacting with LLM's and building editor integrated prompts.
MIT License
337 stars 24 forks source link

Improve README #28

Open gsuuon opened 1 year ago

gsuuon commented 1 year ago
FlippingBinary commented 11 months ago

An example of how to use this plugin with an Ollama server would be great. It looks like this plugin could work with it pretty easily, so I'm going to star this repository and come back to it when I've got some time to fiddle with it.

codetalker7 commented 2 months ago

Some minor points which could help someone like me reading through the README:

  1. For models which require API access, it'll be great to have more examples of chats/templates for non-OpenAI providers (eg. HuggingFace or Groq Cloud; by the way, I think Groq would be a really nice addition to the list of available providers). Maybe it's just a personal taste, but I prefer to "test" out the plugin first with APIs for which I don't have to pay :) And perhaps one of the reasons I love this plugin is because it supports everything: local models, or practically any provider.
  2. Many thanks for the notes on the types/classes that are being used in calling the models! However, while going through the implementation of some providers like OpenAI or HuggingFace, I found some things which were a bit hard to understand on the first attempt. For instance, I had no idea about what the on_message handler does (eg: https://github.com/gsuuon/model.nvim/blob/25d5a317b6bc03e4d3644bf3149e0310cef8b8cc/lua/model/providers/openai.lua#L75) and there wasn't any information about it in the README!
  3. I think the "Examples" section of the README is really good; however, in that section (and in other parts of the README) some videos are used to showcase the power of the plugin. While videos are great (and I really appreciate it), I think they should be accompanied with more docs explaining the stuff as well (because I'll probably look at the docs first, and then an example via any video or image!)

Overall the plugin is really amazing, and I'd love to see (or maybe even contribute) to various other usecases it may provide!

gsuuon commented 2 months ago

Thanks for the detailed feedback! I'll reference this when I take another pass at the readme. I've also been thinking of adding a tutorial style section that walks through building your own prompts, which would address one of your points. Also, contributions are definitely welcome (maybe a Groq provider?)

codetalker7 commented 2 months ago

Thanks for the detailed feedback! I'll reference this when I take another pass at the readme. I've also been thinking of adding a tutorial style section that walks through building your own prompts, which would address one of your points. Also, contributions are definitely welcome (maybe a Groq provider?)

Yes! I'll try to make a PR for a simple Groq chat template as well; will try to make it simple to understand and possibly will include some info in the README.