feat: migrate from Rectify to Repilot

Author: UniverseFly

README.md

@@ -1,66 +1,66 @@
-# ⚙️$`\mathbb{R}\mathrm{ectify}`$🛠️
+# ⚙️$`\mathbb{R}\mathrm{e}\mathbf{pilot}`$🛠️
 
 > [!WARNING]
-> Rectify is being changed to **Repilot**! The patch will come soon. Stay tuned.
+> **Repilot** was originally named **Rectify**. There are still some inconsistencies in the documentation. We will patch them soon. Stay tuned!
 
-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"!
+Welcome to the source code repo of **Repilot**, 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"!
 
 <picture>
-  <source media="(prefers-color-scheme: light)" srcset="/assets/Rectify-Demo-Light.svg">
-  <source media="(prefers-color-scheme: dark)" srcset="/assets/Rectify-Demo-Dark.svg">
-  <img alt="Rectify Demo" src="/assets/Rectify-Demo-Light.svg">
+  <source media="(prefers-color-scheme: light)" srcset="/assets/Repilot-Demo-Light.svg">
+  <source media="(prefers-color-scheme: dark)" srcset="/assets/Repilot-Demo-Dark.svg">
+  <img alt="Repilot Demo" src="/assets/Repilot-Demo-Light.svg">
 </picture>
 
-Rectify leverages the synergy between a semantics-based code completion engine and an auto-regressive large language model for more efficient valid patch generation.
+Repilot 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 directly using our out-of-the-box Docker image**.
+> Repilot 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 Repilot can be non-trivial. Therefore, **we highly recommend directly using our out-of-the-box Docker image**.
 
-## 🚀 Quick start with Rectify's Docker image
+## 🚀 Quick start with Repilot's Docker image
 
 ```bash
 # Pull the image and run a container.
 # This may take some time...
-docker run -it --name rectify universefly/rectify-fse23
+docker run -it --name repilot universefly/repilot-fse23
 # Now you will get into a "virtual environment" provided by Docker
-# Enter the `rectify` directory
-cd /rectify
-# This is important because Rectify relies on a `meta_config.json` file to work properly
+# Enter the `repilot` directory
+cd /root/repilot
+# This is important because Repilot relies on a `meta_config.json` file to work properly
 cat meta_config.json
-# Generate patches with the full Rectify approach using CodeT5
-ACTIVE=1 python -m rectify.cli.main repair -b "Chart-9" --method pruned-mem -d chart-9-rectify -n 5
+# Generate patches with the full Repilot approach using CodeT5
+ACTIVE=1 python -m repilot.cli.main repair -b "Chart-9" --method pruned-mem -d chart-9-repilot -n 5
 # You will see logs about the patch generation and which tokens are accepted/rejected.
 
 # Validate the patch generation
-python -m rectify.cli.main validate -d chart-9-rectify
+python -m repilot.cli.main validate -d chart-9-repilot
 
 # Print a table of the evaluation results
-python -m rectify.cli.main evaluate -d chart-9-rectify
+python -m repilot.cli.main evaluate -d chart-9-repilot
 # You'll see something like this:
-#                                              Rectify Evaluation Results                                              
+#                                              Repilot Evaluation Results                                              
 # ┏━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┓
 # ┃ Tag             ┃ Average Gen Time ┃ %Compilable Patches ┃ %Plausible Patches ┃ #Plausible Fixes ┃ #Correct Fixes ┃
 # ┡━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━┩
-# │ chart-9-rectify │ 1.33s            │ 100.0%              │ 0.000%             │ 0                │ -              │
+# │ chart-9-repilot │ 1.33s            │ 100.0%              │ 0.000%             │ 0                │ -              │
 # └─────────────────┴──────────────────┴─────────────────────┴────────────────────┴──────────────────┴────────────────┘
 ```
 
 ## ️⭐️ Artifact️
 
-For a more comprehensive guidance on how to use Rectify and how to reproduce the results in our paper, we greatly encourage you to check our artifact at https://github.com/UniverseFly/Rectify-Artifact.
+For a more comprehensive guidance on how to use Repilot and how to reproduce the results in our paper, we greatly encourage you to check our artifact at https://github.com/UniverseFly/Repilot-Artifact.
 
 
-## ⚠️ How to build and use Rectify from source?
+## ⚠️ How to build and use Repilot from source?
 
 > [!WARNING]
-> Building Rectify from source is **NOT** recommended since there are many complex dependencies and configurations to handle. It is only for advanced users who want to extend Rectify.
+> Building Repilot from source is **NOT** recommended since there are many complex dependencies and configurations to handle. It is only for advanced users who want to extend Repilot.
 
 > [!IMPORTANT]
 > **Environment requirements**
 > 
 > - Python 3.10 and [Git LFS](https://git-lfs.com) are required.
 > - **All three versions of Java 8, 11, and 18** are required. For convenient management of multiple Java versions, we recommend [coursier](https://get-coursier.io/docs/cli-java).
-> - (Optional) It's recommended to have an NVIDIA GPU with >6G memory for running Rectify with CodeT5 and >30G memory for Incoder-6.7B.
+> - (Optional) It's recommended to have an NVIDIA GPU with >6G memory for running Repilot with CodeT5 and >30G memory for Incoder-6.7B.
 
 <details><summary>Download and build the modified Eclipse JDT Language Server</summary>
 
@@ -93,20 +93,20 @@ java \
 If everything goes well, you can move on to the next step.
 </details>
 
-<details><summary>Download and install Rectify as a Python package including its dependencies</summary>
+<details><summary>Download and install Repilot as a Python package including its dependencies</summary>
 
 ```bash
-git clone https://github.com/UniverseFly/Rectify && cd Rectify
+git clone https://github.com/UniverseFly/Repilot && cd Repilot
 # Do an editable install
 pip install -e .
 # Consider upgrading pip if you encounter any errors, also make sure you are using Python 3.10
-# This command should also install all the dependencies of Rectify
+# This command should also install all the dependencies of Repilot
 ```
 </details>
 
-<details><summary>Prepare the runtime environment of Rectify</summary>
+<details><summary>Prepare the runtime environment of Repilot</summary>
 
-We need to prepare a `meta_config.json` file for Rectify to work properly. The file should be placed in the root directory of Rectify. Please **modify** the following template according to your environment and save the file in the root directory of Rectify:
+We need to prepare a `meta_config.json` file for Repilot to work properly. The file should be placed in the root directory of Repilot. Please **modify** the following template according to your environment and save the file in the root directory of Repilot:
 
 ```json
 {
@@ -139,17 +139,17 @@ We need to prepare a `meta_config.json` file for Rectify to work properly. The f
 
 <details><summary>Install the Defects4j datasets</summary>
 
-Rectify evaluates on the [Defects4j](https://github.com/rjust/defects4j) dataset. Please checkout to its [v2.0.0 release](https://github.com/rjust/defects4j/releases/tag/v2.0.0) and follow its instructions to install the dataset.
+Repilot evaluates on the [Defects4j](https://github.com/rjust/defects4j) dataset. Please checkout to its [v2.0.0 release](https://github.com/rjust/defects4j/releases/tag/v2.0.0) and follow its instructions to install the dataset.
 
 > [!WARNING]
-> If you directly download the release instead of doing a checkout you may encounter errors when running Rectify, as Rectify will dump the metadata by collecting the meta information of these projects as Git repos. If they are not Git repos, Rectify may fail.
+> If you directly download the release instead of doing a checkout you may encounter errors when running Repilot, as Repilot will dump the metadata by collecting the meta information of these projects as Git repos. If they are not Git repos, Repilot may fail.
 
 You can check the installation by running `/path/to/defects4j info -p Chart`.
 
-Now let's `cd` back to the root directory of Rectify, and run the following command to checkout all the bugs:
+Now let's `cd` back to the root directory of Repilot, and run the following command to checkout all the bugs:
 
 ```bash
-python -m rectify.cli.init
+python -m repilot.cli.init
 ```
 
 </details>
@@ -158,9 +158,8 @@ python -m rectify.cli.init
 <details><summary>Do an example run</summary>
 
 ```bash
-# Generate patches with the full Rectify approach using CodeT5
-ACTIVE=1 python -m repilot.cli.main repair -b "Chart-9" --method pruned-mem -d chart-9-repilot -n 5
-# You will see logs about the patch generation and which tokens are accepted/rejected.
+# Generate patches with the full Repilot approach using CodeT5
+ACTIVE=1 python -m repilot.cli.main repair -b "Chart-9" --method pruned-mem -d chart-9-repilot -n 5 # You will see logs about the patch generation and which tokens are accepted/rejected.
 
 # Validate the patch generation
 python -m repilot.cli.main validate -d chart-9-repilot
@@ -174,7 +173,7 @@ You will see a table of evaluation results if everything goes well.
 
 <details><summary>(Optional) Unpack the pre-generated patches</summary>
 
-The GitHub repo also contains pre-generated patches the experiments in our paper. You can unpack if you would like to check them. First make sure you `cd` to the root directory of Rectify. Then run the following command:
+The GitHub repo also contains pre-generated patches the experiments in our paper. You can unpack if you would like to check them. First make sure you `cd` to the root directory of Repilot. Then run the following command:
 
 ```bash
 tar -xvf ./data/large.tar.xz
@@ -184,4 +183,4 @@ Then you will see the `data/large` directory is populated with the pre-generated
 
 </details>
 
-**🔥🔥Congratulations! You have successfully built and used Rectify from source!🔥🔥**
+**🔥🔥Congratulations! You have successfully built and used Repilot from source!🔥🔥**