Added README. Fixes issue #13 #15

imshrishk · 2025-01-27T18:10:33Z

->Eases the install and use process.
->Gives a glimpse of the different prompts used.

chimosky

@kshitijdshah99 please review this and make changes where you think they're needed.

chimosky · 2025-01-27T23:07:40Z

README.md

@@ -0,0 +1,150 @@
+# Sugar AI: Child-Friendly AI Assistant & Python Coding Helper
+
+A dual-purpose AI system combining child-friendly question answering with Python coding assistance using Retrieval-Augmented Generation (RAG).


What do you mean by "dual-purpose"?

By dual purpose, I meant child-friendly and a coding assistant. Is that wrong?

It wasn't clear at first what it was, it also doesn't just help with Python, it specifically can help with Sugar and GTK related questions.

chimosky · 2025-01-27T23:11:04Z

README.md

+### 🌟 Child-Friendly QA (main.py)
+- Answers children's questions using simple language
+- Automatically explains complex terms for 3-year-old understanding
+- GPT-2 model with response limit (60 words)


We're no longer using this, see #12 and #11.

chimosky · 2025-01-27T23:12:46Z

README.md

+- Safety-focused content generation
+
+### 💻 Python Coding Assistant (rag_agent.py)
+- Specialized in Pygame, GTK+, and Sugar Toolkit


Sugar Toolkit Gtk3, because there's a Sugar Toolkit and that's not what this specializes on.

Just noticed that the docs have it named that way, but the content is different.

Should I change it to
-Uses Sugar Toolkit and Gtk3

I'm not sure about this so please help

"Sugar Toolkit Gtk3" not "Sugar Toolkit and Gtk3", one refers to sugar-toolkit-gtk3 and the other refers to sugar-tookit and Gtk3.

chimosky · 2025-01-27T23:18:51Z

README.md

+### Child-Friendly QA
+```python
+from main import AI_Test
+
+assistant = AI_Test()
+response = assistant.generate_bot_response("Why is the sky blue?")
+print(response)
+```
+
+### Coding Assistant
+Start the assistant:
+```bash
+python rag_agent.py
+```
+
+Example session:
+```
+> How to create a window in GTK+3?
+Let's think step by step.
+1. Import Gtk module
+2. Create Window object
+3. Set title and size
+4. Connect delete event
+5. Show all elements
+...
+```


Seeing as this is supposed to be an API, it's not to be used this way, not even when developing.

For local development, you'd have a local server running which you can then send requests to and get a response.

Should I just remove this Usage part or just write use as an API? I have not worked on this project and my understanding comes from just reading the code and documentation so I might be wrong.

You can remove this part for now.

@kshitijdshah99 might write this better.

chimosky · 2025-01-27T23:19:49Z

README.md

+## Project Structure
+```
+sugar-ai/
+├── main.py               - Child QA with GPT-2
+├── rag_agent.py          - Coding assistant with RAG
+├── docs/                 - Documentation PDFs
+└── requirements.txt      - Dependency list
+```
+
+## Configuration
+
+### Document Paths (rag_agent.py)
+```python
+document_paths = [
+    './docs/Pygame Documentation.pdf',
+    './docs/Python GTK+3 Documentation.pdf',
+    './docs/Sugar Toolkit Documentation.pdf'
+]
+```


This should come under a contributing section, here it just seems like bloat and a bit out of place.

chimosky · 2025-01-27T23:21:29Z

README.md

+## Dependencies
+
+### Core Technologies
+- Transformers (Hugging Face)
+- LangChain
+- FAISS (Vector Store)
+- Ollama
+- PyMuPDF (PDF processing)


This seems like bloat because it focuses on just one part of the API, while the other one is ignored.

We're yet to trim our requirements.txt at the moment but this just focuses on one side, I'd rather it not exist that focus on one side.

kshitijdshah99 · 2025-01-28T05:28:29Z

@kshitijdshah99 please review this and make changes where you think they're needed.

Sure I'll make changes soon.

kshitijdshah99 · 2025-01-30T14:08:37Z

@chimosky @pikurasa I feel there's no need to mention dependencies, document paths and some other things here. I am planning to implement following things in my PR.

Intro what Sugar AI is?
What Sugar AI consists of and purpose of those chatbot and AI-assistant including RAG
Code and file structure as shown above
How to setup
Something about docker and Fastapi to get an abstract idea about that how would things integrate.

Is there anything else needed to be added??

pikurasa · 2025-01-30T15:52:57Z

Is there anything else needed to be added??

I think that's a sufficient start. Go ahead and make write those up.

chimosky · 2025-02-03T22:05:02Z

@chimosky @pikurasa I feel there's no need to mention dependencies, document paths and some other things here. I am planning to implement following things in my PR.
1. Intro what Sugar AI is?

2. What Sugar AI consists of and purpose of those chatbot and AI-assistant including RAG

3. Code and file structure as shown above

4. How to setup

5. Something about docker and Fastapi to get an abstract idea about that how would things integrate.
Is there anything else needed to be added??

If you've used things from this PR, please maintain authorship.

kshitijdshah99 · 2025-02-04T05:22:27Z

I got your point but what do you expect me to do for maintaining it. You want me to mention this PR in my PR?

chimosky · 2025-02-04T14:26:18Z

I got your point but what do you expect me to do for maintaining it. You want me to mention this PR in my PR?

I said "maintain authorship", that means maintain the original commit, with an additional commit that has your changes.

If you used things from this PR, it makes sense to give credit to the original author.

docs: add comprehensive README with installation and usage guide

47fa9f4

imshrishk mentioned this pull request Jan 27, 2025

Add a README #13

Open

chimosky reviewed Jan 27, 2025

View reviewed changes

kshitijdshah99 mentioned this pull request Jan 31, 2025

Adding new README Fixes#13 #16

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added README. Fixes issue #13 #15

Added README. Fixes issue #13 #15

imshrishk commented Jan 27, 2025

chimosky left a comment

chimosky Jan 27, 2025

imshrishk Jan 30, 2025

chimosky Feb 3, 2025

chimosky Jan 27, 2025

chimosky Jan 27, 2025

imshrishk Jan 30, 2025

chimosky Feb 3, 2025

chimosky Jan 27, 2025

imshrishk Jan 30, 2025

chimosky Feb 3, 2025

chimosky Jan 27, 2025 •

edited

Loading

chimosky Jan 27, 2025

kshitijdshah99 commented Jan 28, 2025

kshitijdshah99 commented Jan 30, 2025

pikurasa commented Jan 30, 2025

chimosky commented Feb 3, 2025

kshitijdshah99 commented Feb 4, 2025

chimosky commented Feb 4, 2025

		@@ -0,0 +1,150 @@
		# Sugar AI: Child-Friendly AI Assistant & Python Coding Helper

		A dual-purpose AI system combining child-friendly question answering with Python coding assistance using Retrieval-Augmented Generation (RAG).

Added README. Fixes issue #13 #15

Are you sure you want to change the base?

Added README. Fixes issue #13 #15

Conversation

imshrishk commented Jan 27, 2025

chimosky left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chimosky Jan 27, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kshitijdshah99 commented Jan 28, 2025

kshitijdshah99 commented Jan 30, 2025

pikurasa commented Jan 30, 2025

chimosky commented Feb 3, 2025

kshitijdshah99 commented Feb 4, 2025

chimosky commented Feb 4, 2025

chimosky Jan 27, 2025 •

edited

Loading