Skip to content

Commit 39d3d97

Browse files
author
Judd
committed
update readme. make a release.
1 parent 1a7725a commit 39d3d97

File tree

1 file changed

+21
-10
lines changed

1 file changed

+21
-10
lines changed

README.md

+21-10
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ goal to [make](https://github.com/google-deepmind/alphageometry/issues/130)
55
[it](https://github.com/google-deepmind/alphageometry/issues/116)
66
[easy](https://github.com/google-deepmind/alphageometry/issues/96) to use (especially on [Windows](https://github.com/google-deepmind/alphageometry/issues/120)):
77

8-
* Use [ChatLLM.cpp](http://github.com/foldl/chatllm.cpp) for LLM interference.
8+
* Use [ChatLLM.cpp](http://github.com/foldl/chatllm.cpp) for LM interference, no Tensorflow/Jax/Flax.
99

10-
* Greatly **simplified** _requirements.txt_.
10+
* Significantly **simplified** _requirements.txt_.
1111

1212
* Indent with **four** spaces (🖕 two spaces).
1313

@@ -37,21 +37,31 @@ introduced in the [Nature 2024](https://www.nature.com/articles/s41586-023-06747
3737
<img alt="fig1" width="800px" src="fig1.svg">
3838
</center>
3939

40-
## Dependencies
40+
## Get started
4141

42-
1. Install ChatLLM.cpp DLL (or .so whatever)
42+
1. Get the source code.
4343

44-
DLL will be contained in a release. Or, you can [build](https://github.com/foldl/chatllm.cpp/blob/master/docs/binding.md#precondition) `libchatllmb` from source,
45-
and copy the DLL into `src/chatllm/bindings`.
44+
Either clone this repository or download it.
4645

47-
1. Install Python dependencies
46+
1. Install ChatLLM.cpp DLLs (or .so whatever).
47+
48+
You can find prebuilt DLLs in releases. Or, you can [build](https://github.com/foldl/chatllm.cpp/blob/master/docs/binding.md#precondition) `libchatllmb` from source.
49+
Copy these DLLs into `src/chatllm/bindings`.
50+
51+
1. Install Python dependencies.
4852

4953
```sh
5054
pip install -r requirements.txt
5155
```
5256

5357
Optionally, you can create a virtual environment, and then install dependencies into it.
5458

59+
1. Run `run_tests.bat` to check if everything is Ok.
60+
61+
The language model will be downloaded automatically.
62+
63+
1. Run `test.bat` to solve a IMO problem with the AlphaGeometry solver.
64+
5565
## Command line flags
5666

5767
A list of command line flags.
@@ -125,7 +135,7 @@ TIP: Additionally passing the flag `--out_file=path/to/output/text/file.txt`
125135
will write the proof to a text file.
126136

127137
Running on all problems in `imo_ag_30.txt` will yield solutions to
128-
14 of them, as reported in Table 1 in our paper.
138+
14 of them, as reported in Table 1 in the paper.
129139

130140
### Example of AlphaGeometry
131141

@@ -201,7 +211,8 @@ where the points are named alphabetically, and so it expects
201211
the same during test time.
202212

203213
As can be seen in the output, initially DDAR failed to solve the problem.
204-
The LM proposes one auxiliary constructions (Note: Beam search not implemented yet):
214+
The LM proposes one auxiliary construction (Note: Beam search not implemented yet,
215+
and LM will propose only one auxiliary construction.):
205216

206217
* `e = on_line e a c, on_line e b d`, i.e.,
207218
`E` is the intersection of `AC` and `BD`.
@@ -230,7 +241,7 @@ each of them and their description.
230241
| `alphageometry.py` | Main script that loads problems, calls DD+AR or AlphaGeometry solver, and prints solutions. |
231242
| `pretty.py` | Pretty formating the solutions output by solvers. |
232243
| `test_xx.py` | Tests for the corresponding module. |
233-
| `run.sh`/`run.bat` | Script to execute instructions in README. |
244+
| `run.sh`/`run.bat` | Script to run a demo in README. |
234245
| `run_tests.sh`/`run_tests.bat` | Script to execute the test suite. |
235246

236247

0 commit comments

Comments
 (0)