Clarity AI

The Problem

As a developer, we often encountered projects that have problems with coding conventions, code quality, readability, and maintainability. With that in said, we are having trouble to familiarize with everything and might take some time to get back on track. But it's not just our challenge – code turnovers also drain companies of time and money in training

I have worked on this idea based on a practical need I encountered during my internship. Dealing with projects with poor coding conventions was a significant challenge for me, prompting me to develop a solution.

The Solution

Clarity is an AI-powered IDE Extension that serves as an ultimate assistant in complex and unfamiliar coding scenarios. It revolutionizes the way developers understand, write, and debug their codes.

It's like ChatGPT or Github's Copilot, but has knowledge of your entire codebase as well as external data sources, and promotes continuous learning to developers. It offers the following: 1.) Contextual Code Explanation, Generation, and Debugging, 2.) Smart Documentation, 3.) Chat About the Codebase, and 4.) AI-Generated Coding Exercises

How we built it

This project uses Langchain and VS code extension API as its foundation. I take the user's code and break it down into smaller parts, converting them into embeddings using either OpenAI or Cohere. These embeddings are then stored in a FAISS vector store. When users ask questions to the AI, I employ a method called HyDE (Hypothetical Document Embeddings) to perform a similarity search on the entire vector store of code. This helps us find relevant information and provide answers with additional context.

Challenges we ran into

One of the primary hurdles was devising an effective method for conducting a semantic search on the codebase. This involved finding a way to extract and understand the underlying meaning of the code, making it challenging to retrieve relevant information accurately.

Competitive Landscape

Clarity uniquely positions itself in the competitive landscape. There are numerous competitors, such as AI chatbots like Bard and ChatGPT and IDE extensions like Github’s Copilot and Sourcegraph’s Cody. Clarity stands out with IDE integration, adept contextual code explanation, comment generation, and a commitment to fostering continuous developer learning, making it a stand-out solution. This is not merely a claim but is proven by its robust architecture. Based on the tests I've conducted, Clarity has shown unparalleled accuracy and reliability in every aspect of code understanding.

Built With

• cohere
• faiss
• javascript
• langchain
• openai
• vscode