Skip to content
This repository was archived by the owner on Nov 5, 2024. It is now read-only.

Commit fdcd4d8

Browse files
authored
Update README.md
1 parent b494fb7 commit fdcd4d8

1 file changed

Lines changed: 18 additions & 3 deletions

File tree

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
# UpgrAIder: Automatically Updating Deprecated API Usage through LLMs and documentation retrieval
1+
# UpgrAIder
22

3-
The goal of this project is to update outdated code snippets (specifically those that use deprecated library APIs). The technique relies on the usage of a Large Language Model (hence the "AI" in the name), augmented with information retrieved from release notes. More details about the project can be found in [this presentation](https://github.com/githubnext/Upgraider/blob/main/Show-and-Tell/Nadi_ShowAndTell.pdf)
3+
UpgrAIder is a tool for automatically updating outdated code snippets (specifically those that use deprecated library APIs). The underlying technique relies on the usage of a Large Language Model (hence the "AI" in the name), augmented with information retrieved from release notes. More details about the project can be found in [this presentation](https://github.com/githubnext/Upgraider/blob/main/Show-and-Tell/Nadi_ShowAndTell.pdf).
4+
5+
Note that UpgrAIder represents an early exploration of the above technique, and has been made available in open source as a basis for research and exploration.
46

57
## Setup
68

@@ -61,4 +63,17 @@ Experimental/not current used any more: To find differences between two versions
6163

6264
`python src/apiexploration/run_api_diff.py`
6365

64-
which will use the library version info in the `libraries` folders.
66+
which will use the library version info in the `libraries` folders.
67+
68+
# License
69+
70+
This project is licenses under the terms of the MIT open source license. Pleare refer to [MIT](https://github.com/githubnext/UpgrAIder/blob/main/LICENSE) for the full terms.
71+
72+
# Maintainers
73+
74+
- Sarah Nadi (@snadi)
75+
- Max Schaefer (@max-schaefer)
76+
77+
# Support
78+
79+
UpgrAIder is a research prototype and is not officially supported. However, if you have questions or feedback, please file an issue and we will do our best to respond.

0 commit comments

Comments
 (0)