feat: add rectify demo figure

ise-uiuc · Aug 22, 2023 · 9c1104a · 9c1104a
1 parent 033aafb
commit 9c1104a
Show file tree

Hide file tree

Showing 2 changed files with 1,172 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -2,12 +2,12 @@
 
 Welcome to the source code repo of **Rectify**, a patch generation tool introduced in our ESEC/FSE'23 paper "Copiloting the Copilot: Fusing Large Language Models with Completion Engines for Automated Program Repair"!
 
-Rectify leverages the synergy between a semantics-based code completion engine and an auto-regressive large language model for more efficient valid patch generation.
+![A Demo of Rectify](/assets/Rectify-Demo.svg)
 
-TBD SVG
+Rectify leverages the synergy between a semantics-based code completion engine and an auto-regressive large language model for more efficient valid patch generation.
 
 > [!IMPORTANT]
-> Rectify is implemented for Java patch generation as a complex hybrid system combining a [Modified Eclipse JDT Language Server](https://github.com/UniverseFly/eclipse.jdt.ls) and Python's [huggingface/transformers](https://github.com/huggingface/transformers) interface for manipulating large language models. Correctly setting up the dependencies and configurations of Rectify can be non-trivial. Therefore, **we highly recommend you to directly use our out-of-the-box Docker image**.
+> Rectify is implemented for Java patch generation as a complex hybrid system combining a [Modified Eclipse JDT Language Server](https://github.com/UniverseFly/eclipse.jdt.ls) and Python's [huggingface/transformers](https://github.com/huggingface/transformers) interface for manipulating large language models. Correctly setting up the dependencies and configurations of Rectify can be non-trivial. Therefore, **we highly recommend directly using our out-of-the-box Docker image**.
 
 ## 🚀 Quick start with Rectify's Docker image