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

JavaScript API PS #99

Merged
merged 4 commits into from
Jun 5, 2024
Merged

JavaScript API PS #99

merged 4 commits into from
Jun 5, 2024

Conversation

royjhan
Copy link
Contributor

@royjhan royjhan commented Jun 4, 2024

No description provided.

README.md Outdated
### process

```javascript
ollama.process()
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
ollama.process()
ollama.ps()

README.md Outdated
@@ -187,6 +187,14 @@ ollama.embeddings(request)
- `options` `<Options>`: (Optional) Options to configure the runtime.
- Returns: `<EmbeddingsResponse>`

### process
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
### process
### ps

Ideally we describe this a bit but to keep it consistent

@jmorganca jmorganca requested a review from BruceMacD June 4, 2024 22:49
@hopperelec
Copy link
Contributor

hopperelec commented Jun 4, 2024

I agree that the function should be named consistently with existing functions, but I personally don't think functions should need to be named the same as the API endpoint because surely the purpose of this library is to abstract away from the API. Obviously, though, this would be a breaking change, so it would either need to be a major change or act as aliases (perhaps with old ones being deprecated).

Copy link
Collaborator

@BruceMacD BruceMacD left a comment

Choose a reason for hiding this comment

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

Looking good, thanks for adding this. I missed that this would need to be updated.

@@ -0,0 +1,16 @@
import ollama from '../../src/browser'
Copy link
Collaborator

Choose a reason for hiding this comment

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

let's omit this example for now

@royjhan royjhan marked this pull request as ready for review June 5, 2024 18:11
@royjhan royjhan merged commit 944c54c into main Jun 5, 2024
3 checks passed
@royjhan royjhan deleted the royh-api-ps branch June 5, 2024 18:12
@BruceMacD BruceMacD mentioned this pull request Jun 13, 2024
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.

4 participants