nihar-damera commited on
Commit
9ecc809
·
verified ·
1 Parent(s): db3e7c8

Model card: the hook's 20-second limit

Browse files
Files changed (1) hide show
  1. README.md +7 -5
README.md CHANGED
@@ -26,8 +26,10 @@ $ commit-suggestor download
26
  $ git add -p && commit-suggestor suggest
27
  ```
28
 
29
- `commit-suggestor install-hook` pre-fills the message on `git commit`, with an
30
- 8-second limit and never a download inside a commit. The prompt is
 
 
31
  `commit_suggestor/prompt.py` (prompt version 2, without repository context);
32
  asking the model any other way is testing a prompt it was not trained on.
33
  Subjects over 72 characters are shortened at a clause boundary
@@ -107,10 +109,10 @@ rule failed a check against human ratings in v1, so treat it as a proxy.
107
  same subject as fp16 in 25.11% [21.33, 29.11];
108
  ROUGE-L against fp16 2.27 [1.16, 3.41] points.
109
  7.73 s per subject on 4 Kaggle CPU cores,
110
- close to the hook's 8-second limit: on a slow CPU, raise it with
111
- `COMMIT_SUGGESTOR_TIMEOUT`.
112
  - MLX on an Apple M4, 16 GB: 2.68 s to load,
113
- 0.433 s per subject (p95 0.978 s),
114
  1,446 MB peak memory.
115
 
116
  ## Limitations
 
26
  $ git add -p && commit-suggestor suggest
27
  ```
28
 
29
+ `commit-suggestor install-hook` pre-fills the message on `git commit`, with a
30
+ 20-second limit (`COMMIT_SUGGESTOR_TIMEOUT`) and never a download inside a
31
+ commit. The hook loads the model afresh for each commit, so it waits several
32
+ seconds on a Mac and more on a CPU. The prompt is
33
  `commit_suggestor/prompt.py` (prompt version 2, without repository context);
34
  asking the model any other way is testing a prompt it was not trained on.
35
  Subjects over 72 characters are shortened at a clause boundary
 
109
  same subject as fp16 in 25.11% [21.33, 29.11];
110
  ROUGE-L against fp16 2.27 [1.16, 3.41] points.
111
  7.73 s per subject on 4 Kaggle CPU cores,
112
+ after loading. On a slow CPU the hook can pass its 20-second limit; raise it
113
+ with `COMMIT_SUGGESTOR_TIMEOUT`.
114
  - MLX on an Apple M4, 16 GB: 2.68 s to load,
115
+ then 0.433 s per subject (p95 0.978 s),
116
  1,446 MB peak memory.
117
 
118
  ## Limitations