instructor icon indicating copy to clipboard operation
instructor copied to clipboard

Put llm_validator example back in README.md

Open lukestanley opened this issue 1 year ago • 2 comments

Is your feature request related to a problem? Please describe. I saw the llm_validator feature demoed somewhere, and IMO, it makes this library more unique over LMQL, SGLang, Guidance, and Outlines. But I think it got lost from the README while making the backend less OpenAI dependent.

Describe the solution you'd like It should return to the README, maybe using a litellm backend as a more general option? Maybe even using a local model to show off that too?

lukestanley avatar Jul 02 '24 15:07 lukestanley

happy to take a PR

I think what happened was we need to pass client back into the validator now

jxnl avatar Jul 03 '24 02:07 jxnl

I looked at this. It looks like that example was moved to /docs/concepts/reask_validation.md, which is probably the right place for it. If the goal is to emphasize what makes Instructor unique, should some of the content from /docs/concepts/philosophy.md be moved/copied to README? Or should README include links to some of the documentation pages (either on GitHub or on the real doc site)?

atbradley avatar Aug 04 '24 04:08 atbradley

Closing as part of repository maintenance for issues created before 2025.

jxnl avatar Mar 05 '25 00:03 jxnl