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

typescript: publish alpha on npm and lots of cleanup, documentation, and more #913

Merged
merged 1,021 commits into from
Jun 12, 2023
Merged

Conversation

jacoobes
Copy link
Collaborator

@jacoobes jacoobes commented Jun 8, 2023

Describe your changes

Issue ticket number and link

Checklist before requesting a review

  • I have performed a self-review of my code.
  • If it is a core feature, I have added thorough tests.
  • I have added thorough documentation for my code.
  • I have tagged PR with relevant project labels. I acknowledge that a PR without labels may be dismissed.
  • If this PR addresses a bug, I have provided both a screenshot/video of the original bug and the working solution.

Demo

Steps to Reproduce

Notes

justinwangx and others added 30 commits May 23, 2023 13:57
@jacoobes
Copy link
Collaborator Author

jacoobes commented Jun 11, 2023

This pr accomplishes the following:

  • typescript bindings officially on NPM. Will be published under the alpha tag as it is still in active development
    • performant as it handles dynamic library calls natively (no ffi)
    • support for CommonJs and ESM module resolution systems
    • fluent and simple interface
  • documentation
  • API resemblance of its python counterpart
  • Utilities including downloading models and retrieval of available models

I'll mark as ready once everything is good to review

@jacoobes
Copy link
Collaborator Author

This commit also rewrites the history to remove *.dll and *.so files specifically in the typescript directory that we accidentally committed. This changes commit https://github.com/jacoobes/gpt4all/commit/394fd301d1b7db4f01f0a0cd621c58f01bb791f1, which made git diverge history.

https://discord.com/channels/1076964370942267462/1096848919473946694/1117439497240592484

I used the git filter-repo --invert-paths --path-glob '**/*{.dll, .so}' --path gpt4all-bindings/typescript/runtimes
command from https://github.com/newren/git-filter-repo/#simple-example-with-comparisons, so it shouldn't affect other paths in the repository

Apologies for the weird git stuff. If this PR needs to be redone, I can redo it

@jacoobes jacoobes marked this pull request as ready for review June 12, 2023 18:41
@jacoobes jacoobes requested a review from manyoso June 12, 2023 18:42
@manyoso manyoso merged commit 8d53614 into nomic-ai:main Jun 12, 2023
@saul-jb
Copy link

saul-jb commented Jun 13, 2023

  • typescript bindings officially on NPM. Will be published under the alpha tag as it is still in active development

Is this currently published to NPM? If not how far off is it?

@jacoobes
Copy link
Collaborator Author

jacoobes commented Jun 13, 2023 via email

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.