Commit Graph

296 Commits

Author SHA1 Message Date
Georgi Gerganov 3a8a3891b3 readme : update hot topics 2023-04-28 21:32:52 +03:00
Folko-Ven afe6563a58 Correcting link to w64devkit (#1214)
Correcting link to w64devkit (change seeto to skeeto).
2023-04-28 16:22:48 +02:00
Georgi Gerganov f9318ab76d readme : add quantization info 2023-04-26 23:24:42 +03:00
DaniAndTheWeb 8ad378c494 Updating build instructions to include BLAS support (#1183)
* Updated build information

First update to the build instructions to include BLAS.

* Update README.md

* Update information about BLAS

* Better BLAS explanation

Adding a clearer BLAS explanation and adding a link to download the CUDA toolkit.

* Better BLAS explanation

* BLAS for Mac

Specifying that BLAS is already supported on Macs using the Accelerate Framework.

* Clarify the effect of BLAS

* Windows Make instructions

Added the instructions to build with Make on Windows

* Fixing typo

* Fix trailing whitespace
2023-04-26 22:03:03 +02:00
Pavol Rusnak 9e63abecf7 quantize : use `map` to assign quantization type from `string` (#1191)
instead of `int` (while `int` option still being supported)

This allows the following usage:

`./quantize ggml-model-f16.bin ggml-model-q4_0.bin q4_0`

instead of:

`./quantize ggml-model-f16.bin ggml-model-q4_0.bin 2`
2023-04-26 18:43:27 +02:00
mgroeber9110 094250bc21 examples/main README improvements and some light refactoring (#1131) 2023-04-24 15:45:32 +00:00
Pavol Rusnak 0ba63e81ff readme : update gpt4all instructions (#980) 2023-04-23 10:21:26 +02:00
CRD716 7ecc2d9e42 Minor: Readme fixed grammar, spelling, and misc updates (#1071) 2023-04-19 19:52:14 +00:00
Georgi Gerganov 068083ca76 readme : add warning about Q4_2 and Q4_3 2023-04-19 19:07:54 +03:00
Georgi Gerganov 426d0c45f4 readme : update hot topics about new LoRA functionality 2023-04-18 20:10:26 +03:00
Atsushi Tatsuma 3c9a24cc72 readme : add Ruby bindings (#1029) 2023-04-17 22:34:35 +03:00
comex 3573ed90b8 py : new conversion script (#545)
Current status: Working, except for the latest GPTQ-for-LLaMa format
  that includes `g_idx`.  This turns out to require changes to GGML, so
  for now it only works if you use the `--outtype` option to dequantize it
  back to f16 (which is pointless except for debugging).

  I also included some cleanup for the C++ code.

  This script is meant to replace all the existing conversion scripts
  (including the ones that convert from older GGML formats), while also
  adding support for some new formats.  Specifically, I've tested with:

  - [x] `LLaMA` (original)
  - [x] `llama-65b-4bit`
  - [x] `alpaca-native`
  - [x] `alpaca-native-4bit`
  - [x] LLaMA converted to 'transformers' format using
        `convert_llama_weights_to_hf.py`
  - [x] `alpaca-native` quantized with `--true-sequential --act-order
        --groupsize 128` (dequantized only)
  - [x] same as above plus `--save_safetensors`
  - [x] GPT4All
  - [x] stock unversioned ggml
  - [x] ggmh

  There's enough overlap in the logic needed to handle these different
  cases that it seemed best to move to a single script.

  I haven't tried this with Alpaca-LoRA because I don't know where to find
  it.

  Useful features:

  - Uses multiple threads for a speedup in some cases (though the Python
    GIL limits the gain, and sometimes it's disk-bound anyway).

  - Combines split models into a single file (both the intra-tensor split
    of the original and the inter-tensor split of 'transformers' format
    files).  Single files are more convenient to work with and more
    friendly to future changes to use memory mapping on the C++ side.  To
    accomplish this without increasing memory requirements, it has some
    custom loading code which avoids loading whole input files into memory
    at once.

  - Because of the custom loading code, it no longer depends in PyTorch,
    which might make installing dependencies slightly easier or faster...
    although it still depends on NumPy and sentencepiece, so I don't know
    if there's any meaningful difference.  In any case, I also added a
    requirements.txt file to lock the dependency versions in case of any
    future breaking changes.

  - Type annotations checked with mypy.

  - Some attempts to be extra user-friendly:

      - The script tries to be forgiving with arguments, e.g. you can
        specify either the model file itself or the directory containing
        it.

      - The script doesn't depend on config.json / params.json, just in
        case the user downloaded files individually and doesn't have those
        handy.  But you still need tokenizer.model and, for Alpaca,
        added_tokens.json.

      - The script tries to give a helpful error message if
        added_tokens.json is missing.
2023-04-14 10:03:03 +03:00
CRD716 d74ce11c25 readme : remove python 3.10 warning (#929) 2023-04-13 16:59:53 +03:00
Genkagaku.GPT c720fa4877 readme : llama node binding (#911)
* chore: add nodejs binding

* chore: add nodejs binding
2023-04-13 16:54:27 +03:00
Judd b9a4538eaa zig : update build.zig (#872)
* update

* update readme

* minimize the changes.

---------

Co-authored-by: zjli2019 <zhengji.li@ingchips.com>
2023-04-13 16:43:22 +03:00
Georgi Gerganov be7082caef readme : change "GPU support" link to discussion 2023-04-12 14:48:57 +03:00
Georgi Gerganov 9b68f0ee36 readme : update hot topics with link to "GPU support" issue 2023-04-12 14:31:12 +03:00
Nicolai Weitkemper e610019c01 readme: link to sha256sums file (#902)
This is to emphasize that these do not need to be obtained from elsewhere.
2023-04-12 08:46:20 +02:00
Pavol Rusnak e4d3b4b251 Fix whitespace, add .editorconfig, add GitHub workflow (#883) 2023-04-11 19:45:44 +00:00
qouoq 4b0adc70d7 Add BAIR's Koala to supported models (#877) 2023-04-10 22:41:53 +02:00
Pavol Rusnak 944d161986 Make docker instructions more explicit (#785) 2023-04-06 08:56:58 +02:00
Georgi Gerganov 0470adafd0 Update README.md 2023-04-05 19:54:30 +03:00
Georgi Gerganov a19b5cee08 readme : change logo + add bindings + add uis + add wiki 2023-04-05 18:56:20 +03:00
Adithya Balaji 5cdd9ef43f readme : update with CMake and windows example (#748)
* README: Update with CMake and windows example

* README: update with code-review for cmake build
2023-04-05 17:36:12 +03:00
Thatcher Chamberlin 01e2261e5f Add a missing step to the gpt4all instructions (#690)
`migrate-ggml-2023-03-30-pr613.py` is needed to get gpt4all running.
2023-04-02 12:48:57 +02:00
rimoliga 34977d15c2 readme: replace termux links with homepage, play store is deprecated (#680) 2023-04-01 16:57:30 +02:00
Pavol Rusnak e88a8002b5 drop quantize.py (now that models are using a single file) 2023-03-31 01:07:32 +02:00
Georgi Gerganov e19e304480 readme : update supported models 2023-03-30 22:31:54 +03:00
Georgi Gerganov 32d84d4876 readme : fix typos 2023-03-29 19:38:31 +03:00
Georgi Gerganov 689ed6a51e readme : add GPT4All instructions (close #588) 2023-03-29 19:37:20 +03:00
Stephan Walter 3b8b2c584a Update README and comments for standalone perplexity tool (#525) 2023-03-26 16:14:01 +03:00
Georgi Gerganov 3600f1d140 Add logo to README.md 2023-03-26 10:20:49 +03:00
Georgi Gerganov 9d678e17dc Move chat scripts into "./examples" 2023-03-25 20:37:09 +02:00
Georgi Gerganov 1c1459f073 Remove obsolete information from README 2023-03-25 16:30:32 +02:00
Gary Mulder ccf5a1b08d Update README.md (#444)
Added explicit **bolded** instructions clarifying that people need to request access to models from Facebook and never through through this repo.
2023-03-24 15:23:09 +00:00
Georgi Gerganov 1f369c619d Add link to Roadmap discussion 2023-03-24 09:13:35 +02:00
Stephan Walter 3ebb023fb2 Revert "Delete SHA256SUMS for now" (#429)
* Revert "Delete SHA256SUMS for now (#416)"

This reverts commit 8eea5ae0e5f31238a97c79ea9103c27647380e37.

* Remove ggml files until they can be verified
* Remove alpaca json
* Add also model/tokenizer.model to SHA256SUMS + update README

---------

Co-authored-by: Pavol Rusnak <pavol@rusnak.io>
2023-03-23 15:15:48 +01:00
Gary Mulder e689dccbad Move model section from issue template to README.md (#421)
* Update custom.md

* Removed Model section as it is better placed in README.md

* Updates to README.md model section

* Inserted text that was removed from  issue template about obtaining models from FB and links to papers describing the various models

* Removed IPF down links for the Alpaca 7B models as these look to be in the old data format and probably shouldn't be directly linked to, anyway

* Updated the perplexity section to point at Perplexity scores #406 discussion
2023-03-23 11:30:40 +00:00
Georgi Gerganov a1b7fa8c60 Adjust repetition penalty .. 2023-03-23 10:46:58 +02:00
Georgi Gerganov 1d31d737d8 Add link to recent podcast about whisper.cpp and llama.cpp 2023-03-23 09:48:51 +02:00
Gary Linscott 686427a35f Add details on perplexity to README.md (#395) 2023-03-22 08:53:54 -07:00
Georgi Gerganov 1deed1f1e7 Remove temporary notice and update hot topics 2023-03-22 07:34:02 +02:00
Gary Mulder 3081cf8ed9 Add SHA256SUMS file and instructions to README how to obtain and verify the downloads
Hashes created using:

sha256sum models/*B/*.pth models/*[7136]B/ggml-model-f16.bin* models/*[7136]B/ggml-model-q4_0.bin* > SHA256SUMS
2023-03-21 23:19:11 +01:00
Georgi Gerganov 278d9b3d84 Add notice about pending change 2023-03-21 22:57:35 +02:00
Georgi Gerganov e7a75316dc Minor style changes 2023-03-21 18:10:32 +02:00
Georgi Gerganov f57b30a8e1 Add chat.sh script 2023-03-21 18:09:46 +02:00
Georgi Gerganov 614b1afa1c Fix convert script, warnings alpaca instructions, default params 2023-03-21 17:59:16 +02:00
Kevin Kwok 9c26af616b Update IPFS links to quantized alpaca with new tokenizer format (#352) 2023-03-21 17:34:49 +02:00
Mack Straight 60d93896be sentencepiece bpe compatible tokenizer (#252)
* potential out of bounds read

* fix quantize

* style

* Update convert-pth-to-ggml.py

* mild cleanup

* don't need the space-prefixing here rn since main.cpp already does it

* new file magic + version header field

* readme notice

* missing newlines

Co-authored-by: slaren <2141330+slaren@users.noreply.github.com>
2023-03-20 03:17:23 -07:00
Suaj Carrot 3eaf221dee Improved quantize script (#222)
* Improved quantize script

I improved the quantize script by adding error handling and allowing to select many models for quantization at once in the command line. I also converted it to Python for generalization as well as extensibility.

* Fixes and improvements based on Matt's observations

Fixed and improved many things in the script based on the reviews made by @mattsta. The parallelization suggestion is still to be revised, but code for it was still added (commented).

* Small fixes to the previous commit

* Corrected to use the original glob pattern

The original Bash script uses a glob pattern to match files that have endings such as ...bin.0, ...bin.1, etc. That has been translated correctly to Python now.

* Added support for Windows and updated README to use this script

New code to set the name of the quantize script binary depending on the platform has been added (quantize.exe if working on Windows) and the README.md file has been updated to use this script instead of the Bash one.

* Fixed a typo and removed shell=True in the subprocess.run call

Fixed a typo regarding the new filenames of the quantized models and removed the shell=True parameter in the subprocess.run call as it was conflicting with the list of parameters.

* Corrected previous commit

* Small tweak: changed the name of the program in argparse

This was making the automatic help message to be suggesting the program's usage as being literally "$ Quantization Script [arguments]". It should now be something like "$ python3 quantize.py [arguments]".
2023-03-19 20:38:44 +02:00
Georgi Gerganov eed44b2875 Update hot topics to mention Alpaca support 2023-03-19 19:51:55 +02:00
Georgi Gerganov b3bd91ce9d Add instruction for using Alpaca (#240) 2023-03-19 18:49:50 +02:00
Pavol Rusnak f9cb6f8979 Fix typo in readme 2023-03-18 23:18:04 +01:00
Pavol Rusnak cc4ace10bf Add note about Python 3.11 to readme 2023-03-18 22:25:35 +01:00
Pavol Rusnak 0bfb4f160f Add memory/disk requirements to readme 2023-03-18 22:25:35 +01:00
Georgi Gerganov b57c1e4295 Update Contributing section 2023-03-17 20:30:04 +02:00
Stephan Walter 45113b2f42 Don't tell users to use a bad number of threads (#243)
The readme tells people to use the command line option "-t 8", causing 8
threads to be started. On systems with fewer than 8 cores, this causes a
significant slowdown. Remove the option from the example command lines
and use /proc/cpuinfo on Linux to determine a sensible default.
2023-03-17 19:47:35 +02:00
Bernat Vadell afcd16588e 🚀 Dockerize llamacpp (#132)
* feat: dockerize llamacpp

* feat: split build & runtime stages

* split dockerfile into main & tools

* add quantize into tool docker image

* Update .devops/tools.sh

Co-authored-by: Georgi Gerganov <ggerganov@gmail.com>

* add docker action pipeline

* change CI to publish at github docker registry

* fix name runs-on macOS-latest is macos-latest (lowercase)

* include docker versioned images

* fix github action docker

* fix docker.yml

* feat: include all-in-one command tool & update readme.md

---------

Co-authored-by: Georgi Gerganov <ggerganov@gmail.com>
2023-03-17 10:47:06 +01:00
Georgi Gerganov b73c11ea8c Update README.md 2023-03-16 15:00:09 +02:00
Georgi Gerganov be7fc04a86 Expand "Contributing" section 2023-03-16 08:55:13 +02:00
Georgi Gerganov e27ab8cb60 Update hot topics - RMSnorm 2023-03-16 07:12:12 +02:00
moritzbrantner 3ffbb46e32 fixed typo (#178) 2023-03-15 22:35:25 +02:00
Musab Gultekin 3a59f2ef9b Fix potential licensing issue (#126)
* Update README.md

* Update README.md

remove facebook
2023-03-15 21:39:06 +02:00
Radoslav Gerganov 1db7851d94 Add section to README on how to run the project on Android (#130) 2023-03-14 15:30:08 +02:00
Georgi Gerganov 96d900134f Add Misc section + update hot topics + minor fixes 2023-03-14 09:43:52 +02:00
Georgi Gerganov 3cd7c8e227 Update contribution section, hot topics, limitations, etc. 2023-03-13 19:21:51 +02:00
Pavol Rusnak b84a31d659 Add quantize script for batch quantization (#92)
* Add quantize script for batch quantization

* Indentation

* README for new quantize.sh

* Fix script name

* Fix file list on Mac OS

---------

Co-authored-by: Georgi Gerganov <ggerganov@gmail.com>
2023-03-13 18:15:20 +02:00
Georgi Gerganov 67d50a97b4 Add initial contribution guidelines 2023-03-13 09:42:26 +02:00
Georgi Gerganov c240cd1e05 Update README.md 2023-03-12 23:39:01 +02:00
Matvey Soloviev d35528087e Add interactive mode (#61)
* Initial work on interactive mode.

* Improve interactive mode. Make rev. prompt optional.

* Update README to explain interactive mode.

* Fix OS X build
2023-03-12 23:13:28 +02:00
Marc Köhlbrugge 8de246c2d8 Fix typo in README (#45) 2023-03-12 22:30:08 +02:00
Georgi Gerganov f6f3f1c7c1 Update README.md 2023-03-12 22:09:26 +02:00
Georgi Gerganov 85c71945cf Revert "weights_only" arg - this causing more trouble than help 2023-03-12 20:59:01 +02:00
Oleksandr Nikitin a7cf72d75e python/pytorch compat notes (#44) 2023-03-12 14:16:33 +02:00
Georgi Gerganov dc91ec5d67 Clarify meaning of hacking 2023-03-12 09:03:25 +02:00
Georgi Gerganov 95fb97b137 README: add "Supported platforms" + update hot topics 2023-03-12 08:41:54 +02:00
Georgi Gerganov e34e3e21c4 Update README.md 2023-03-12 01:26:32 +02:00
Juraj Bednar 4cdcd39348 Fix a typo in model name (#16) 2023-03-11 19:32:20 +02:00
Georgi Gerganov 284d9be2de Update README.md 2023-03-11 18:10:18 +02:00
Georgi Gerganov cc0f26bef3 Add AVX2 support for x86 architectures thanks to @Const-me ! 2023-03-11 18:04:25 +02:00
Georgi Gerganov 35cb0d2a39 Update README.md 2023-03-11 12:31:21 +02:00
Georgi Gerganov 2d2cadab68 Update Makefile var + add comment 2023-03-11 12:27:02 +02:00
Georgi Gerganov 657074b014 Update README.md 2023-03-11 11:34:25 +02:00
Georgi Gerganov b53c6356f3 Update README.md 2023-03-11 11:34:11 +02:00
Georgi Gerganov a2799521b9 Support all LLaMA models + change Q4_0 quantization storage 2023-03-11 11:28:30 +02:00
Simon Willison d4919344b1 Include Python dependencies in README (#6) 2023-03-11 07:47:26 +02:00
Georgi Gerganov 11dae511e3 Update README.md 2023-03-11 01:30:47 +02:00
Georgi Gerganov 240b0bf6ea Update README.md 2023-03-11 01:22:58 +02:00
Georgi Gerganov 87da10c739 Update README.md 2023-03-11 01:18:10 +02:00
Georgi Gerganov 01e3d38e1c Update README.md 2023-03-11 00:55:22 +02:00
Georgi Gerganov 8d38e7e279 Update README.md 2023-03-11 00:51:46 +02:00
Georgi Gerganov 586e0f1f3d Update README.md 2023-03-11 00:09:19 +02:00
Georgi Gerganov 4c7f13c170 Update README.md 2023-03-10 23:53:11 +02:00
Georgi Gerganov 44f3a5b932 Update README.md 2023-03-10 21:52:27 +02:00
Georgi Gerganov 3cda59d04e Final touches 2023-03-10 21:50:46 +02:00
Georgi Gerganov b2a7bb3e19 Create README.md 2023-03-10 21:47:46 +02:00