-
Notifications
You must be signed in to change notification settings - Fork 8.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
examples: remove codified examples #8267
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would it be worth keeping this in the api
package? e.g. api/examples
? I don't think it's a must-have but is handy for anyone using that code (and perhaps we could move it in a follow up?)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I actually think we shouldn't have go examples since we don't officially support this + can be an unstable interface so I'm a bit hesitant to have this in there. I think curl examples as what we have in our docs is the way to go but happy to chat
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's an exposed package and these are generally nice and simple. For this PR, I think what makes sense is to keep them under api/examples
with better directory names (but definitely not top level), and if, similar to the other examples we find them falling behind we can remove them in a follow up.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Okay, let me move it to under there for now and then also do some sanity checks to make sure they're up to date. I do think we should talk about what level API consistencies we should guarantee if we're having that in examples
c804715
to
05e0aba
Compare
@@ -12,3 +12,9 @@ Ollama JavaScript examples at [ollama-js/examples](https://github.com/ollama/oll | |||
|
|||
## OpenAI compatibility examples | |||
Ollama OpenAI compatibility examples at [ollama/examples/openai](../docs/openai.md) | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we want to just remove this directory altogether?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm I think people usually look for some reference to examples. I'd be okay with moving this readme to examples.md
what do you think?
This PR aims to streamline the examples and to have outgoing links to community frameworks instead.
Closes #8117