ollama / ollama-python

Ollama Python library

https://ollama.com

MIT License

4.09k stars 344 forks source link

doc(README) : add prerequisites #45

Closed adriens closed 4 months ago

adriens commented 8 months ago

:grey_question: About

While trying to play with ollama-python on a brand new env, I found out that following the current steps of the README do not take in account that ollama must be up and running (ie. that it's not ollama-python role).

:dart: Objective

The purpose of this PR is to make the Getting started even easier to people can just copy/paste and enjoy :smile:

adriens commented 8 months ago

:pray: @mikeesto for the code suggestion :smile_cat:

mak448a commented 7 months ago

This would close #29.

connor-makowski commented 7 months ago

Worth mentioning that there are a few ways to do this. For example, you might also add something like:

## Local Ollama Setup
You need to have a local ollama server running to be able to continue. To do this:

- Download: https://ollama.com/
- Run an LLM: https://ollama.com/library
    - Example: `ollama run llama2`
    - Example: `ollama run llama2:70b`

adriens commented 7 months ago

:pray: @connor-makowski

haesleinhuepf commented 7 months ago

Big thanks @adriens

adriens commented 7 months ago

Big thanks @adriens

That was a very modest contribution, but it's always very cool to get feedbacks from projects you really enjoy a lot working with :star_struck: @haesleinhuepf

haesleinhuepf commented 4 months ago

Dear maintainers,

this is a very useful documentation update. Consider merging it. 😉

adriens commented 4 months ago

:partying_face:

adriens commented 4 months ago

connor-makowski commented 4 months ago

Referencing this to: https://github.com/ollama/ollama-python/pull/155 as an extension for adding clarity to the getting started process.