Skip to content

Commit d89de37

Browse files
committed
Update README
1 parent 9609c1c commit d89de37

File tree

2 files changed

+30
-12
lines changed

2 files changed

+30
-12
lines changed

README.md

+30-12
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# leetcode-summerizer
1+
# Leetcode-Summarizer 1.0
22
Summarize and collect into a DB a collection of LeetCode problems (Description, Solutions, Code, Analysis)
33

44
## 📣 News
@@ -37,27 +37,45 @@ This project harnesses the power of OpenAI's GPT models to summarize LeetCode pr
3737
- Run the main script: `python main.py`
3838
- Make sure you have your problem inputs ready in `prompt_arguments.csv`.
3939

40+
6. **File Structure and Data Schemas:**
41+
- `app.log`: Logs all runtime information, including progress updates and errors. Data schema: Timestamp, Log Level, Message.
42+
- `prompts.log`: Stores detailed prompt templates used for each request. Data schema: Prompt Template, Problem.
43+
- `prompt_arguments.csv`: Input file containing LeetCode problem descriptions. Should have a header named "problem" followed by rows containing individual problem descriptions or titles.
44+
4045
### Open AI Platform Issues
4146

42-
#### ChatGPT API Setup Challenges
43-
- **New API endpoint updates:**
44-
- The current endpoint used in this code is "https://api.openai.com/v1/chat/completions".
45-
- This endpoint is one of the options for both "gpt-3.5-turbo" (default in this code) and "gpt-4" models.
46-
- Each endpoint supports only a certain class of models.
47-
- Explore the latest "endpoints" and their compatible models in [Open AI's platform documentation](https://platform.openai.com/docs/models/model-endpoint-compatibility).
48-
- **New format for request message (currently ChatML format).**
49-
- **You have to upgrade to a paid account and add credits to your account:**
50-
- There’s a known bug with the payment system. You may get the "Error 429 Too Many Requests" from Open AI Api while adding your payment method. You may need to install a VPN (as I did as the last solution) to get around this issue [Link: https://techviral.net/chatgpt-error-429-too-many-requests/], or wait for it to be resolved, hopefully soon.
51-
- **You need to re-generate your Open AI key after upgrading the billing account and store the new API key in your bash_profile for use in the python code. Otherwise, you will get the error "404 Client Error: Not Found for url: https://api.openai.com/v1/completions".**
47+
- **ChatGPT API Setup Challenges**
48+
- **New API endpoint updates:**
49+
- The current endpoint used in this code is "https://api.openai.com/v1/chat/completions".
50+
- This endpoint is one of the options for both "gpt-3.5-turbo" (default in this code) and "gpt-4" models.
51+
- Each endpoint supports only a certain class of models.
52+
- Explore the latest "endpoints" and their compatible models in [Open AI's platform documentation](https://platform.openai.com/docs/models/model-endpoint-compatibility).
53+
- **New format for request message (currently ChatML format).**
54+
- **You have to upgrade to a paid account and add credits to your account:**
55+
- There’s a known bug with the payment system. You may get the `Error 429 Too Many Requests` from Open AI Api while adding your payment method. You may need to install a VPN (as I did as the last solution) to get around this issue ([Link](https://techviral.net/chatgpt-error-429-too-many-requests/)), or wait for it to be resolved, hopefully soon!
56+
- **You need to re-generate your Open AI key after upgrading the billing account and store the new API key in your bash_profile for use in the python code. Otherwise, you will get the error `404 Client Error: Not Found for url: https://api.openai.com/v1/completions`**.
5257

5358
## 💻 Recommended Code Editor
5459

5560
- Suggestion is using [Visual Studio Code](https://code.visualstudio.com/) for an enhanced coding experience with this project.
5661

5762
## 🎶 A Fun Fact
5863

59-
- This README and the accompanying code were crafted while listening to some energetic techno beats! Techno is love ❤️. Check out some of my DJ mixes (Organic House, and Melodic House and Techno) [here on Soundcloud](https://soundcloud.com/alireza_deer)!
64+
- 🎧: This README and the accompanying code were crafted while listening to some energetic techno beats! 🎶 Techno is love ❤️.
65+
- <img src="image.png" alt="Alt text" style="width: 20px; height: 20px;"> Check out some of my DJ mixes (Organic House, Melodic House and Techno) [here on Soundcloud](https://soundcloud.com/alirezadir)!
66+
- 🎧🎵 My current favorite track: [Simulation](https://open.spotify.com/playlist/3p52wFvY1hYMzjQJnkkfxW) *by "Anyma & Chris Avantgarde".*
6067

6168
## 🙌 Credits
6269

6370
- This project was created with assistance from my ChatGPT assistant, who was indispensable in writing the code and crafting this README.
71+
72+
## 🌟 Gratitude
73+
74+
🙏 I am deeply grateful for being where I am today and for the opportunity to share this work with you all. 🌍 It's been a long, challenging journey filled with excitement from the start to this point. I am thankful for all the gifts that the universe has brought to me, and I've discovered that living with gratitude is a profoundly transformative way of life. 🌈
75+
76+
> To speak gratitude is courteous and pleasant, to enact gratitude is generous and noble, but to live gratitude is to touch Heaven. – Johannes A. Gaertner (*German Art Historian, Professor of Art History*)
77+
78+
🙏 Special thanks go to my very close friends who have always supported me throughout my journey.
79+
80+
🙏 I am also eternally grateful to all my teachers who have guided me from the very beginning until now. Their wisdom and support have been invaluable.
81+

image.png

23.7 KB
Loading

0 commit comments

Comments
 (0)