Readme update (#13)

* Create devskim.yml * Create super-linter.yml * Update devskim.yml * Initial commit * Added flow diagram to readme * Updated readme.md * Update README.md * Update README.md * Update README.md * Readme update (#4) * Merging dev with master (#3) * Create devskim.yml * Create super-linter.yml * Update devskim.yml * Initial commit * Added flow diagram to readme * Updated readme.md * Update README.md * Update README.md * Update README.md * Added methodology to README * Updated README with plans * Updated README Added the plan for the development of the atlas project
amarquaye · Jul 1, 2024 · 095ee45 · 095ee45
1 parent 9af2869
commit 095ee45
Show file tree

Hide file tree

Showing 2 changed files with 106 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -10,6 +10,7 @@ computer engineering students from [Ghana Communication Technology University](h
   - [Why Atlas?](#why-atlas)
   - [Aims or Objectives](#aims-or-objectives)
 - [Methodology](#methodology)
+  - [Plan](#plan)
 
 ## Introduction
 
@@ -63,10 +64,20 @@ An additional feature (probably in the future) will be to find the sources of th
 
 ### What we plan to do
 
-- [ ] Create a site to test how atlas will detect hallucinations in LLMs.
-- [ ] Create browser extension to finally test how atlas will operate.
+- Detect and mitigate hallucinations in the form of generated text.
 
 ### What we do not plan to do
 
 - ~~Detecting and mitigating hallucination in images generated by LLMs.~~
 - ~~Detecting and mitigating hallucination in videos generated by LLMs.~~
+
+### Plan
+
+- [x] Develop an api to search the web. Click to [try it out](https://atlasproject-brown.vercel.app/docs "Test the API").
+- [ ] Scrape the contents of the resulting links from the search.
+- [ ] Summarize the contents of the extracted text.
+- [ ] Identify the difference between the LLM's response and the results from our search.
+- [ ] Prompt the user of potential hallucinations if any are detected.
+- [ ] Mitigate by allowing the user to dive deeper and if he or she is satisfied, substitute the LLM's response with ours.
+- [ ] Create a site to test how atlas will detect hallucinations in LLMs.
+- [ ] Create browser extension to finally test how atlas will operate.
diff --git a/docs/img/flow.drawio b/docs/img/flow.drawio
@@ -0,0 +1,93 @@
+<mxfile host="65bd71144e">
+    <diagram id="ZPgNhMFsD9aIJOTKAWIQ" name="Page-1">
+        <mxGraphModel dx="618" dy="571" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">
+            <root>
+                <mxCell id="0"/>
+                <mxCell id="1" parent="0"/>
+                <mxCell id="12" value="Start" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1">
+                    <mxGeometry x="270" y="110" width="120" height="60" as="geometry"/>
+                </mxCell>
+                <mxCell id="13" value="User queries LLM" style="shape=process;whiteSpace=wrap;html=1;backgroundOutline=1;" parent="1" vertex="1">
+                    <mxGeometry x="270" y="220" width="120" height="60" as="geometry"/>
+                </mxCell>
+                <mxCell id="14" value="End" style="rounded=0;whiteSpace=wrap;html=1;" parent="1" vertex="1">
+                    <mxGeometry x="270" y="720" width="120" height="60" as="geometry"/>
+                </mxCell>
+                <mxCell id="15" value="Atlas scans response and checks for signs of hallucination" style="shape=process;whiteSpace=wrap;html=1;backgroundOutline=1;" parent="1" vertex="1">
+                    <mxGeometry x="270" y="340" width="120" height="60" as="geometry"/>
+                </mxCell>
+                <mxCell id="16" value="" style="endArrow=classic;html=1;exitX=0.5;exitY=1;exitDx=0;exitDy=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" parent="1" source="12" target="13" edge="1">
+                    <mxGeometry width="50" height="50" relative="1" as="geometry">
+                        <mxPoint x="290" y="290" as="sourcePoint"/>
+                        <mxPoint x="330" y="150" as="targetPoint"/>
+                    </mxGeometry>
+                </mxCell>
+                <mxCell id="17" value="" style="endArrow=classic;startArrow=classic;html=1;exitX=0.5;exitY=0;exitDx=0;exitDy=0;entryX=0.5;entryY=1;entryDx=0;entryDy=0;" parent="1" source="15" target="13" edge="1">
+                    <mxGeometry width="50" height="50" relative="1" as="geometry">
+                        <mxPoint x="290" y="290" as="sourcePoint"/>
+                        <mxPoint x="340" y="240" as="targetPoint"/>
+                    </mxGeometry>
+                </mxCell>
+                <mxCell id="21" value="Hallucination detection" style="rhombus;whiteSpace=wrap;html=1;" parent="1" vertex="1">
+                    <mxGeometry x="270" y="470" width="120" height="100" as="geometry"/>
+                </mxCell>
+                <mxCell id="22" value="Propmt the user of possible hallucinations" style="rounded=1;whiteSpace=wrap;html=1;" parent="1" vertex="1">
+                    <mxGeometry x="10" y="490" width="120" height="60" as="geometry"/>
+                </mxCell>
+                <mxCell id="24" value="Continue scanning response from LLM" style="rounded=1;whiteSpace=wrap;html=1;" parent="1" vertex="1">
+                    <mxGeometry x="580" y="490" width="120" height="60" as="geometry"/>
+                </mxCell>
+                <mxCell id="27" value="" style="endArrow=classic;startArrow=classic;html=1;entryX=0.5;entryY=1;entryDx=0;entryDy=0;exitX=0.5;exitY=0;exitDx=0;exitDy=0;" parent="1" source="21" target="15" edge="1">
+                    <mxGeometry width="50" height="50" relative="1" as="geometry">
+                        <mxPoint x="340" y="390" as="sourcePoint"/>
+                        <mxPoint x="370" y="420" as="targetPoint"/>
+                    </mxGeometry>
+                </mxCell>
+                <mxCell id="29" value="Crawl the web for the right response and present to the user" style="rounded=1;whiteSpace=wrap;html=1;" parent="1" vertex="1">
+                    <mxGeometry x="10" y="610" width="120" height="60" as="geometry"/>
+                </mxCell>
+                <mxCell id="30" value="" style="endArrow=classic;html=1;entryX=0.5;entryY=0;entryDx=0;entryDy=0;exitX=0.5;exitY=1;exitDx=0;exitDy=0;" parent="1" source="22" target="29" edge="1">
+                    <mxGeometry width="50" height="50" relative="1" as="geometry">
+                        <mxPoint x="320" y="550" as="sourcePoint"/>
+                        <mxPoint x="370" y="500" as="targetPoint"/>
+                    </mxGeometry>
+                </mxCell>
+                <mxCell id="33" value="" style="curved=1;endArrow=classic;html=1;entryX=0.5;entryY=0;entryDx=0;entryDy=0;exitX=0.5;exitY=1;exitDx=0;exitDy=0;" parent="1" source="29" target="14" edge="1">
+                    <mxGeometry width="50" height="50" relative="1" as="geometry">
+                        <mxPoint x="320" y="650" as="sourcePoint"/>
+                        <mxPoint x="370" y="600" as="targetPoint"/>
+                        <Array as="points">
+                            <mxPoint x="100" y="750"/>
+                            <mxPoint x="370" y="650"/>
+                            <mxPoint x="350" y="640"/>
+                            <mxPoint x="320" y="600"/>
+                        </Array>
+                    </mxGeometry>
+                </mxCell>
+                <mxCell id="34" value="&lt;h1&gt;&lt;span style=&quot;background-color: initial;&quot;&gt;Flow Diagram&lt;/span&gt;&lt;br&gt;&lt;/h1&gt;" style="text;html=1;strokeColor=none;fillColor=none;spacing=5;spacingTop=-20;whiteSpace=wrap;overflow=hidden;rounded=0;" parent="1" vertex="1">
+                    <mxGeometry x="235" y="50" width="190" height="120" as="geometry"/>
+                </mxCell>
+                <mxCell id="36" value="" style="endArrow=classic;html=1;entryX=1;entryY=0.5;entryDx=0;entryDy=0;exitX=0;exitY=0.5;exitDx=0;exitDy=0;" parent="1" source="21" target="22" edge="1">
+                    <mxGeometry relative="1" as="geometry">
+                        <mxPoint x="290" y="580" as="sourcePoint"/>
+                        <mxPoint x="390" y="580" as="targetPoint"/>
+                    </mxGeometry>
+                </mxCell>
+                <mxCell id="37" value="Hallucination dectected" style="edgeLabel;resizable=0;html=1;align=center;verticalAlign=middle;" parent="36" connectable="0" vertex="1">
+                    <mxGeometry relative="1" as="geometry"/>
+                </mxCell>
+                <mxCell id="38" value="" style="endArrow=classic;html=1;entryX=0;entryY=0.5;entryDx=0;entryDy=0;exitX=1;exitY=0.5;exitDx=0;exitDy=0;" parent="1" source="21" target="24" edge="1">
+                    <mxGeometry relative="1" as="geometry">
+                        <mxPoint x="180" y="580" as="sourcePoint"/>
+                        <mxPoint x="280" y="580" as="targetPoint"/>
+                    </mxGeometry>
+                </mxCell>
+                <mxCell id="39" value="No detection" style="edgeLabel;resizable=0;html=1;align=center;verticalAlign=middle;" parent="38" connectable="0" vertex="1">
+                    <mxGeometry relative="1" as="geometry">
+                        <mxPoint x="-4" as="offset"/>
+                    </mxGeometry>
+                </mxCell>
+            </root>
+        </mxGraphModel>
+    </diagram>
+</mxfile>