Skip to content
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

doc: add info on running with remote ollama #83

Merged
merged 1 commit into from
Oct 15, 2024

Conversation

mhdawson
Copy link
Contributor

I think running with a remote ollama instance will be a relatively common use case.

Having this little bit of extra info would have
saved me time and void me having to hunt through the code and other examples to figure out how to use my remote instance.

Which issue(s) does this pull-request address?

While working through the initial example I had to spend some time figuring out how to use my existing remote ollama instance. I believe this will be common enough that it's worth adding a small section to help people avoid that additional effort when trying out the first example.

Closes: #

Description

Adds the info to the README.md to show how to use a remote ollama instance.

Checklist

  • I have read the contributor guide
  • Linting passes: yarn lint or yarn lint:fix
  • Formatting is applied: yarn format or yarn format:fix
  • Unit tests pass: yarn test:unit
  • E2E tests pass: yarn test:e2e
  • Tests are included
  • Documentation is changed or added
  • Commit messages and PR title follow conventional commits

@Tomas2D Tomas2D self-requested a review October 11, 2024 16:40
Copy link
Contributor

@Tomas2D Tomas2D left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IDEs provide type-hints on what you can pass to the class.
This code snippet only bloats the README, but feel free to add this here examples/llms/providers/ollama.ts .

@mhdawson
Copy link
Contributor Author

Lots of us don't use an IDE but up to you.

When adding to examples/llms/providers/ollama.ts do you mean to add the client options to one of the existing examples or adding a new one with something like "===REMOTE OLLAMA===" ?

@Tomas2D
Copy link
Contributor

Tomas2D commented Oct 11, 2024

Yes, please add it to the example.

===REMOTE OLLAMA== or ===CUSTOM CONFIGURATION=== whatever you deem appropriate 👍🏻

@Tomas2D
Copy link
Contributor

Tomas2D commented Oct 15, 2024

@mhdawson, are you still going to do it?

@mhdawson
Copy link
Contributor Author

@Tomas2D will do it today, Monday was a holiday in Canada where I am.

I think running with a remote ollama instance will be a relatively
common use case.

Having this little bit of extra info would have
saved me time and void me having to hunt through the code and other
examples to figure out how to use my remote instance.

Signed-off-by: Michael Dawson <[email protected]>
@mhdawson
Copy link
Contributor Author

@Tomas2D updated.

Copy link
Contributor

@Tomas2D Tomas2D left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you.

@Tomas2D Tomas2D merged commit ed6405d into i-am-bee:main Oct 15, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants