Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
j6k4m8 authored Jun 3, 2024
1 parent 7d54b98 commit afc0e15
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,12 @@ https://github.com/KordingLab/llm4papers/assets/693511/a642c534-50d7-4feb-aa16-d
- Run the server from this repository (`poetry run python3 llm4papers/service.py`)
- Open the paper in Overleaf and edit as you usually would. When you want to invoke the AI assistant, add a comment with the following format: `@ai: <command>`. For example, `the brain is weird. % @ai: formalize this`
- The AI assistant will replace lines on which this comment is found with the output of the command.

## License

This code is NOT licensed for re-use or publication, and is only for use by Kording Lab affiliates.
-

## Technical Overview

This plugin works by cloning the Overleaf git repository and editing files locally in `/tmp` and then pushing them back to the remote. This is done using the `git` Python library.

Other document APIs can be added by implementing the `PaperRemote` protocol in [the `paper_remote` module](llm4papers/paper_remote/__init__.py). For an example, see the `OverleafGitPaperRemote` class.

<hr /><p align='center'><small>Made with 💚 at <a href='https://kordinglab.com/'> the Kording Lab <img alt='KordingLab.com' align='center' src='https://github.com/KordingLab/chatify-server/assets/693511/39f519fe-b05d-43fb-a5d4-f6792de1dbb6' height='32px'></a></small></p>

0 comments on commit afc0e15

Please sign in to comment.