From 73db96cd2c21dbbc5e4113082f0e281cee845feb Mon Sep 17 00:00:00 2001 From: Rahul <35rahuldshetty@gmail.com> Date: Tue, 8 Aug 2023 00:25:37 +0530 Subject: [PATCH] updated documentation --- README.md | 39 +++++++--- docs/README.md | 6 +- docs/_coverpage.md | 3 + docs/_media/icon-512.png | Bin 0 -> 50673 bytes docs/_media/logo.png | Bin 0 -> 125786 bytes docs/_media/logo.pxz | Bin 0 -> 38895 bytes docs/examples.md | 8 +- docs/index.html | 1 + docs/quick_start.md | 2 +- examples/gpt2_roleplay.html | 130 -------------------------------- examples/quick_start/index.html | 11 --- examples/quick_start/script.js | 42 ----------- examples/starcoder.html | 118 ----------------------------- 13 files changed, 44 insertions(+), 316 deletions(-) create mode 100644 docs/_media/icon-512.png create mode 100644 docs/_media/logo.png create mode 100644 docs/_media/logo.pxz delete mode 100644 examples/gpt2_roleplay.html delete mode 100644 examples/quick_start/index.html delete mode 100644 examples/quick_start/script.js delete mode 100644 examples/starcoder.html diff --git a/README.md b/README.md index d4e6f7f..aa3ca0f 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,36 @@ -# ggml.js +
+ + + +
-## Build +# ggml.js -You can follow the [BUILD.md](docs/BUILD.md) guide to build ggml.js JavaScript bundles. +> Run any [ggml](https://github.com/ggerganov/ggml.git) ported ML models directly on your web browser with ggml.js -## Examples +Example projects built with ggml.js: [Live Demo](https://rahuldshetty.github.io/ggml.js-examples/) -Get started with some example projects: +You can find the package documentation for this project: [Documentation](https://rahuldshetty.github.io/ggml.js/) -| Name | Description | Source code | -|-------------------|----------------------------------|-------------------------------| -| Tiny Starcoder | Demo on [tiny starcoder](https://huggingface.co/bigcode/tiny_starcoder_py) | [link](examples/basic.html) | \ No newline at end of file +Models Supported: +- [Dolly v2](https://github.com/ggerganov/ggml/tree/master/examples/dolly-v2) +- [GPT2](https://github.com/ggerganov/ggml/tree/master/examples/gpt-2) +- [GPT J](https://github.com/ggerganov/ggml/tree/master/examples/gpt-j) +- [GPT NEO X](https://github.com/ggerganov/ggml/tree/master/examples/gpt-neox) +- [MPT](https://github.com/ggerganov/ggml/tree/master/examples/mpt) +- [Replit](https://github.com/ggerganov/ggml/tree/master/examples/replit) +- [StarCoder](https://github.com/ggerganov/ggml/tree/master/examples/starcoder) + +*More models will be added in future* + +## Installation + +Download and extract latest [release](https://github.com/rahuldshetty/ggml.js/releases) of ggml.js package to your web project. + +*OR* + +You can follow the [Build](/BUILD.md) guide to generate ggml.js JavaScript bundles from scratch. diff --git a/docs/README.md b/docs/README.md index 1bd53a5..5fdb103 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,6 +2,10 @@ Run any [ggml](https://github.com/ggerganov/ggml.git) ported ML models directly on your web browser with ggml.js +ggml.js provides JavaScript bindings for interacting with GGML quantized ML models. + +Example projects built with ggml.js: [Live Demo](https://rahuldshetty.github.io/ggml.js-examples/) + Models Supported: - [Dolly v2](https://github.com/ggerganov/ggml/tree/master/examples/dolly-v2) - [GPT2](https://github.com/ggerganov/ggml/tree/master/examples/gpt-2) @@ -11,7 +15,7 @@ Models Supported: - [Replit](https://github.com/ggerganov/ggml/tree/master/examples/replit) - [StarCoder](https://github.com/ggerganov/ggml/tree/master/examples/starcoder) - +*More models will be added in future* ## Installation diff --git a/docs/_coverpage.md b/docs/_coverpage.md index eab8a0c..8e4e44f 100644 --- a/docs/_coverpage.md +++ b/docs/_coverpage.md @@ -1,11 +1,14 @@ + + # ggml.js 1.0.0 > Run any [ggml](https://github.com/ggerganov/ggml.git) ported ML models directly on your browser - Serverless & Edge AI 🤖 - JavaScript ES6 Package 🧰 +- Powered by WebAssembly [GitHub](https://github.com/rahuldshetty/ggml.js.git) [Get Started](#ggmljs) diff --git a/docs/_media/icon-512.png b/docs/_media/icon-512.png new file mode 100644 index 0000000000000000000000000000000000000000..5646b1701146799cc06af1c83f7f892a5f777bb0 GIT binary patch literal 50673 zcmeFY^>4c4uyDM{aK6{dZ
z5Lul*r}*RFh6E{GUF|6N;9B#c<71Hzz%jdOBRN9fI^uPrLGM+k#;ljpf4>)-92eUy
z=n!(ZR?P$ f?
z4nv45R25%~Ry}p>w40eUWK{r4LU&eI@i@c~EP$gs-T3zTQhgLHA&!5{ce}>qo#?ch
z^L;Z9*g(ePi>T3}JS-63ZwUdc#|$8Q3)CKX7ZQQWn*%t?1X?=a !K;X<^b#dD69z)I?2L%1qq0b?3DyaBpWYL`Yn@`HU{ox+m_Nh*W)C5c(g2irM)ikAcr
z$pO_ddj6(bi2Q78htn#D_=gXrvcWj`_
Y}_?Wgt-T?nNeTiyih&gZo2X
z0}=PE<(5Nj!r@b
Q*7{K|gJFRq<`WS5MAyan+>$5^qe&JqaM`X#tQWqd
z4ft@-QskVLI$U?Y_uI}kzC(umImyYny8UiFdU>Oxld-yhlofp
?%D?=2|qv%(W$~oRx`)LN)E^aF_kk
z#+gRpu4c&MUhM`$77M7RH?>4}UHj+!*_RNawVNzXwti&162{{IJ6%DMTnc;W8sWTq
zq9`q(fG!Vl+|7w-Ya@qHVIuFMf*##+SJ-5S@M*@=j10Mn9T<0bM(EL*vlPPr}dU
z`L`~-`O5sf