ollama-python icon indicating copy to clipboard operation
ollama-python copied to clipboard

doc(README) : add prerequisites

Open adriens opened this issue 5 months ago • 6 comments

: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 avatar Jan 31 '24 10:01 adriens

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

adriens avatar Feb 01 '24 20:02 adriens

This would close #29.

mak448a avatar Feb 13 '24 01:02 mak448a

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`

connor-makowski avatar Feb 13 '24 20:02 connor-makowski

:pray: @connor-makowski

adriens avatar Feb 15 '24 20:02 adriens

Big thanks @adriens

haesleinhuepf avatar Feb 22 '24 08:02 haesleinhuepf

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

adriens avatar Feb 22 '24 10:02 adriens

Dear maintainers,

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

haesleinhuepf avatar May 08 '24 20:05 haesleinhuepf

:partying_face:

adriens avatar May 09 '24 22:05 adriens

Tweet

image

adriens avatar May 11 '24 20:05 adriens

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

connor-makowski avatar May 13 '24 15:05 connor-makowski