Skip to content

Commit 7ec903d

Browse files
authored
Update contribution section, hot topics, limitations, etc.
1 parent 4497ad8 commit 7ec903d

File tree

1 file changed

+8
-18
lines changed

1 file changed

+8
-18
lines changed

README.md

Lines changed: 8 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,6 @@
55

66
Inference of [Facebook's LLaMA](https://github.com/facebookresearch/llama) model in pure C/C++
77

8-
**Hot topics**
9-
10-
- Running on Windows: https://github.com/ggerganov/llama.cpp/issues/22
11-
- Fix Tokenizer / Unicode support: https://github.com/ggerganov/llama.cpp/issues/11
12-
138
## Description
149

1510
The main goal is to run the model using 4-bit quantization on a MacBook
@@ -23,14 +18,14 @@ The main goal is to run the model using 4-bit quantization on a MacBook
2318

2419
This was [hacked in an evening](https://github.com/ggerganov/llama.cpp/issues/33#issuecomment-1465108022) - I have no idea if it works correctly.
2520
Please do not make conclusions about the models based on the results from this implementation.
26-
For all I know, it can be completely wrong. This project is for educational purposes and is not going to be maintained properly.
27-
New features will probably be added mostly through community contributions, if any.
21+
For all I know, it can be completely wrong. This project is for educational purposes.
22+
New features will probably be added mostly through community contributions.
2823

2924
Supported platforms:
3025

3126
- [X] Mac OS
3227
- [X] Linux
33-
- [ ] Windows (soon)
28+
- [X] Windows (via CMake)
3429

3530
---
3631

@@ -179,10 +174,6 @@ Note the use of `--color` to distinguish between user input and generated text.
179174

180175
## Limitations
181176

182-
- Not sure if my tokenizer is correct. There are a few places where we might have a mistake:
183-
- https://github.com/ggerganov/llama.cpp/blob/26c084662903ddaca19bef982831bfb0856e8257/convert-pth-to-ggml.py#L79-L87
184-
- https://github.com/ggerganov/llama.cpp/blob/26c084662903ddaca19bef982831bfb0856e8257/utils.h#L65-L69
185-
In general, it seems to work, but I think it fails for unicode character support. Hopefully, someone can help with that
186177
- I don't know yet how much the quantization affects the quality of the generated text
187178
- Probably the token sampling can be improved
188179
- The Accelerate framework is actually currently unused since I found that for tensor shapes typical for the Decoder,
@@ -192,16 +183,15 @@ Note the use of `--color` to distinguish between user input and generated text.
192183

193184
### Contributing
194185

195-
- There are 2 git branches: [master](https://github.com/ggerganov/llama.cpp/commits/master) and [dev](https://github.com/ggerganov/llama.cpp/commits/dev)
196-
- Contributors can open PRs to either one
197-
- Collaborators can push straight into `dev`, but need to open a PR to get stuff to `master`
186+
- Contributors can open PRs
187+
- Collaborators can push to branches in the `llama.cpp` repo
198188
- Collaborators will be invited based on contributions
199-
- `dev` branch is considered unstable
200-
- `master` branch is considered stable and approved. 3-rd party projects should use the `master` branch
201189

202-
General principles to follow when writing code:
190+
### Coding guide-lines
203191

204192
- Avoid adding third-party dependencies, extra files, extra headers, etc.
205193
- Always consider cross-compatibility with other operating systems and architectures
206194
- Avoid fancy looking modern STL constructs, use basic for loops, avoid templates, keep it simple
207195
- There are no strict rules for the code style, but try to follow the patterns in the code (indentation, spaces, etc.). Vertical alignment makes things more readable and easier to batch edit
196+
- Clean-up any tailing whitespaces, use 4 spaces indentation, brackets on same line, `int * var`
197+
- Look at the [good first issues](https://github.com/ggerganov/llama.cpp/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) for tasks

0 commit comments

Comments
 (0)