Merge pull request #312 from alakob/llm_engineering_blaise_alako_contrib
Pull Request: Week 4 & 5 Course contribution
This commit is contained in:
Ed Donner
GitHub
@@ -4,96 +4,113 @@
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"## codeXchange AI: Transform Code with a Click!\n",
|
||||
"# codeXchange AI: Transform Code with a Click!\n",
|
||||
"\n",
|
||||
"**Created by Blaise Alako**\n",
|
||||
"\n",
|
||||
"Get ready to revolutionize your coding experience with **codeXchange AI**—a web-based Gradio app that converts code between programming languages in a flash! Powered by cutting-edge frontier and open-source LLMs, this tool is a game-changer for beginners diving into new languages, intermediates streamlining projects, and advanced users pushing the limits of innovation. Just paste or upload your code, choose your target language, and watch the magic unfold!\n",
|
||||
"**codeXchange AI** is a web-based tool that simplifies converting code between different programming languages. It uses advanced open-source language models and cutting-edge AI to quickly and accurately translate your code. Supporting conversion across 17 programming languages, this tool is perfect whether you’re learning a new language or optimizing multi-language projects. With its user-friendly interface, you can even have your code documented automatically by simply ticking the documentation option—this adds appropriate docstrings following the native documentation style of the target language. Developed as part of the [LLM Engineering course](https://www.udemy.com/course/llm-engineering-master-ai-and-large-language-models/learn/lecture/46867711#content) by Ed. Donner.\n",
|
||||
"\n",
|
||||
"**Why codeXchange AI?**\n",
|
||||
"- **Effortless**: No downloads—just pure web-based magic.\n",
|
||||
"- **Brilliant**: AI-driven conversions that nail accuracy.\n",
|
||||
"- **Adaptable**: Add new languages or models with ease.\n",
|
||||
"\n",
|
||||
"Explore the source code [codeXchange AI](https://github.com/alakob/ai_code_converter) and experience the thrill!\n",
|
||||
"**Key Features of codeXchange AI:**\n",
|
||||
"- **Effortless Conversion:** A fully web-based solution that requires no local installations.\n",
|
||||
"- **AI-Driven Accuracy:** Harnessing advanced language models for reliable and contextually accurate code conversions.\n",
|
||||
"- **Adaptable and Scalable:** Easily extend the tool to accommodate new languages and transformation models.\n",
|
||||
"\n",
|
||||
"Discover more details and explore the project on the [codeXchange AI GitHub repository](https://github.com/alakob/ai_code_converter).\n",
|
||||
"\n",
|
||||
"---\n",
|
||||
"\n",
|
||||
"### Table of Contents\n",
|
||||
"1. [Explore the Interface](#explore-the-interface)\n",
|
||||
"2. [Upload and Convert](#upload-and-convert)\n",
|
||||
"3. [See the Results](#see-the-results)\n",
|
||||
"4. [Unleash Advanced Features](#unleash-advanced-features)\n",
|
||||
"5. [Performance That Wows](#performance-that-wows)\n",
|
||||
"6. [Get Started Now](#get-started-now)\n",
|
||||
"1. [Overview of codeXchange AI](#overview-of-codexchange-ai)\n",
|
||||
"2. [Uploading Your Code](#uploading-your-code)\n",
|
||||
"3. [Instant Conversion Process](#instant-conversion-process)\n",
|
||||
"4. [Reviewing the Results](#reviewing-the-results)\n",
|
||||
"5. [Advanced Customization Options](#advanced-customization-options)\n",
|
||||
"6. [Performance and Optimization](#performance-and-optimization)\n",
|
||||
"7. [Get Started with codeXchange AI](#get-started-with-codexchange-ai)\n",
|
||||
"\n",
|
||||
"---\n",
|
||||
"\n",
|
||||
"### Explore the Interface\n",
|
||||
"## Overview of codeXchange AI\n",
|
||||
"\n",
|
||||
"#### A Sleek Starting Point\n",
|
||||
"Step into the world of codeXchange AI with its stunningly simple interface, designed to make your coding journey a breeze!\n",
|
||||
"### A Seamless Code Transformation Tool\n",
|
||||
"**codeXchange AI** delivers an accessible yet powerful solution for converting code between programming languages. Designed with both novice coders and experienced developers in mind, it highlights how modern AI can simplify and accelerate the code migration process. Immerse yourself in a world where conversion is not only accurate but also a valuable learning opportunity.\n",
|
||||
"\n",
|
||||
" \n",
|
||||
"*Screenshot: The app’s clean starting screen, ready for your code.*\n",
|
||||
"\n",
|
||||
"With options to upload files or pick example snippets, you’re just a click away from transforming your code.\n",
|
||||
" \n",
|
||||
"*Figure 1: The welcoming interface of codeXchange AI, inviting you to begin your transformative journey.*\n",
|
||||
"\n",
|
||||
"---\n",
|
||||
"\n",
|
||||
"### Upload and Convert\n",
|
||||
"## Uploading Your Code\n",
|
||||
"\n",
|
||||
"#### Load Your Code with Ease\n",
|
||||
"Whether you’re a beginner or a pro, uploading your code is a snap. Drag and drop a file, or select a preloaded snippet to kick things off.\n",
|
||||
"### Prepare Your Source Code for Conversion\n",
|
||||
"Experience the ease of preparing your code for a swift transformation. The intuitive upload section allows you to drag-and-drop your files or select from preloaded example snippets, making the initiation process both fast and user-friendly.\n",
|
||||
"\n",
|
||||
" \n",
|
||||
"*Screenshot: The upload section with a dropdown for example snippets.*\n",
|
||||
" \n",
|
||||
"*Figure 2: The upload area featuring convenient options to either insert your code directly or choose from examples.*\n",
|
||||
"\n",
|
||||
"Choose your input language, pick your target, and hit “Convert”—it’s that easy to bridge the language gap!\n",
|
||||
"This design caters to a variety of programming languages, ensuring your input is processed with high precision from the outset.\n",
|
||||
"\n",
|
||||
"---\n",
|
||||
"\n",
|
||||
"### See the Results\n",
|
||||
"## Instant Conversion Process\n",
|
||||
"\n",
|
||||
"#### Witness the Transformation\n",
|
||||
"Watch codeXchange AI work its magic! It converts your code with precision, adding helpful documentation to make the output crystal clear.\n",
|
||||
"### Transform Your Code in Real Time\n",
|
||||
"Once your code is submitted, codeXchange AI activates its powerful engine. Simply select your target language and hit “Convert.” The application seamlessly translates your code, incorporating essential documentation to ensure clarity, usability, and maintainability.\n",
|
||||
"\n",
|
||||
" \n",
|
||||
"*Screenshot: A converted result with documentation, ready to run.*\n",
|
||||
" \n",
|
||||
"*Figure 3: The real-time conversion stage, where your code is transformed with integrated documentation.*\n",
|
||||
"\n",
|
||||
"From Python to C++ or beyond, the app ensures your code is ready to shine in its new language.\n",
|
||||
"This process not only demystifies the syntactical shifts between languages but also serves as an insightful demonstration of AI's capabilities in practical coding scenarios.\n",
|
||||
"\n",
|
||||
"---\n",
|
||||
"\n",
|
||||
"### Unleash Advanced Features\n",
|
||||
"## Reviewing the Results\n",
|
||||
"\n",
|
||||
"#### Power Up Your Workflow\n",
|
||||
"For those who love to tinker, codeXchange AI offers exciting customization! Select different models, adjust the “Temperature” for creative flair, and even add new languages to the mix.\n",
|
||||
"### Examine Your Newly Transformed Code\n",
|
||||
"After conversion, the output is presented with meticulous attention to detail. The translated code retains its logic and documentation integrity, ensuring compatibility for both testing and production environments.\n",
|
||||
"\n",
|
||||
" \n",
|
||||
"*Screenshot: Interface showcasing model selection, temperature slider, and more.*\n",
|
||||
" \n",
|
||||
"*Figure 4: The output display, showcasing the fully converted code complete with insightful documentation.*\n",
|
||||
"\n",
|
||||
"Download your converted code with a single click and take your projects to the next level!\n",
|
||||
"This clear and organized presentation guarantees that your new code is production-ready and easily maintainable.\n",
|
||||
"\n",
|
||||
"---\n",
|
||||
"\n",
|
||||
"### Performance That Wows\n",
|
||||
"## Advanced Customization Options\n",
|
||||
"\n",
|
||||
"#### Speed That Impresses\n",
|
||||
"codeXchange AI doesn’t just convert—it optimizes! Check out the performance boost when running your code in a new language, with execution times that’ll leave you amazed.\n",
|
||||
"### Tailor Your Conversion Experience\n",
|
||||
"For users who wish to fine-tune their conversion settings, codeXchange AI offers a suite of advanced options. Customize parameters such as the AI model selection and “Temperature” settings to introduce creative variations in the output. Additionally, the platform readily supports the addition of new languages and LLM models as your needs evolve.\n",
|
||||
"\n",
|
||||
" \n",
|
||||
"*Screenshot: Execution results highlighting speed improvements.*\n",
|
||||
" \n",
|
||||
"*Figure 5: The advanced settings panel featuring options for model selection, temperature control, and further customization.*\n",
|
||||
"\n",
|
||||
"From 31.49 seconds in Python to just 2.32 seconds in C++—see the difference for yourself!\n",
|
||||
"This flexibility ensures that the tool can be precisely adapted to your development environment and evolving project requirements.\n",
|
||||
"\n",
|
||||
"---\n",
|
||||
"\n",
|
||||
"### Get Started Now\n",
|
||||
"## Performance and Optimization\n",
|
||||
"\n",
|
||||
"Ready to transform your coding game? Jump into [codeXchange AI source code](https://github.com/alakob/ai_code_converter) Convert, run, and download your code in seconds. Whether you’re just starting out, managing complex projects, or innovating at an advanced level, this app is your ultimate coding companion.\n",
|
||||
"### Experience Lightning-Fast Conversions\n",
|
||||
"codeXchange AI not only transforms your code but also optimizes it for superior performance. Witness remarkable enhancements in execution speed across languages as the tool refines the code translation process. These performance metrics clearly demonstrate the efficiency gains achieved through AI-powered conversion.\n",
|
||||
"\n",
|
||||
"---\n"
|
||||
" \n",
|
||||
"*Figure 6: Detailed performance metrics showcasing execution time improvements across different programming languages.*\n",
|
||||
"\n",
|
||||
"With conversion times reduced dramatically, you’re empowered to focus on innovation and development without delay.\n",
|
||||
"\n",
|
||||
"---\n",
|
||||
"\n",
|
||||
"## Get Started with codeXchange AI\n",
|
||||
"\n",
|
||||
"### Embark on Your Code Transformation Journey\n",
|
||||
"Are you ready to enhance your coding skills and explore new possibilities? Dive into the full source code and setup instructions on [GitHub – codeXchange AI](https://github.com/alakob/ai_code_converter). Whether you're experimenting with new languages, updating legacy projects, or pushing the frontiers of innovation, exploring codeXchange AI will expand your understanding of AI-driven code transformation.\n",
|
||||
"\n",
|
||||
"---\n",
|
||||
"\n",
|
||||
"### Acknowledgments\n",
|
||||
"Special thanks to Ed. Donner for his transformative [LLM Engineering course](https://www.udemy.com/course/llm-engineering-master-ai-and-large-language-models/learn/lecture/46867711#content) that inspired this project.\n",
|
||||
"\n"
|
||||
]
|
||||
}
|
||||
],
|
||||
|
||||
BIN
week5/community-contributions/docuSeekAI/doc_upload.png
Normal file
BIN
week5/community-contributions/docuSeekAI/doc_upload.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 29 KiB |
101
week5/community-contributions/docuSeekAI/docuSeekAI.ipynb
Normal file
101
week5/community-contributions/docuSeekAI/docuSeekAI.ipynb
Normal file
@@ -0,0 +1,101 @@
|
||||
{
|
||||
"cells": [
|
||||
{
|
||||
"cell_type": "markdown",
|
||||
"metadata": {},
|
||||
"source": [
|
||||
"# DocuSeek AI: Secure and Intelligent Document Retrieval\n",
|
||||
"\n",
|
||||
"**Created by Blaise Alako**\n",
|
||||
"\n",
|
||||
"**DocuSeek AI** is a tool designed to enable secure and intelligent interaction with private documents. It utilizes a Retrieval-Augmented Generation (RAG) system, combining Large Language Models (LLMs) and vector search to provide accurate, context-aware responses based on uploaded content. Developed as part of [LLM Engineering course](https://www.udemy.com/course/llm-engineering-master-ai-and-large-language-models/learn/lecture/46867711#content) by Ed. Donner, it demonstrates practical applications of AI in document processing and data privacy, offering a hands-on example of secure, AI-driven data retrieval.\n",
|
||||
"\n",
|
||||
"**Key Features of DocuSeek AI:**\n",
|
||||
"- **Privacy-Focused**: All data is processed locally, ensuring your documents remain private.\n",
|
||||
"- **Intelligent**: Leverages LLMs and vector search for precise, contextually relevant answers.\n",
|
||||
"- **Versatile**: Supports multiple file formats and provides interactive visualizations of data relationships.\n",
|
||||
"\n",
|
||||
"Explore the source code and setup instructions at [DocuSeek AI GitHub](https://github.com/alakob/ai_private_document_retriever) to experiment with RAG systems and LLM applications in document retrieval.\n",
|
||||
"\n",
|
||||
"---\n",
|
||||
"\n",
|
||||
"### Table of Contents\n",
|
||||
"1. [Overview of DocuSeek AI](#overview-of-docuseek-ai)\n",
|
||||
"2. [Document Upload and Processing](#document-upload-and-processing)\n",
|
||||
"3. [Querying Your Documents](#querying-your-documents)\n",
|
||||
"4. [Visualizing Data Relationships](#visualizing-data-relationships)\n",
|
||||
"5. [Setup and Exploration](#setup-and-exploration)\n",
|
||||
"\n",
|
||||
"---\n",
|
||||
"\n",
|
||||
"## Overview of DocuSeek AI\n",
|
||||
"\n",
|
||||
"### An AI-Powered Document Retrieval Tool\n",
|
||||
"**DocuSeek AI** provides an intuitive interface for users to interact with their private documents using AI technology. It is designed to be accessible to users of all levels while showcasing advanced concepts such as Retrieval-Augmented Generation (RAG) and vector-based search.\n",
|
||||
"\n",
|
||||
" \n",
|
||||
"*Figure 1: The main interface of DocuSeek AI, where users begin their document exploration journey.*\n",
|
||||
"\n",
|
||||
"The tool integrates seamlessly with local files, ensuring data privacy and security throughout the process.\n",
|
||||
"\n",
|
||||
"---\n",
|
||||
"\n",
|
||||
"## Document Upload and Processing\n",
|
||||
"\n",
|
||||
"### Preparing Your Files for Intelligent Querying\n",
|
||||
"To begin, users upload their documents in supported formats (e.g., PDFs, XLSX, PPTX, HTML, PNG, JPEG, TIFF, BMP, JSON, USPTO XML, JATS XML, Markdown, SdciiDoc, text files). DocuSeek AI processes these files locally, transforming them into a searchable knowledge base optimized for AI-driven querying.\n",
|
||||
"\n",
|
||||
" \n",
|
||||
"*Figure 2: The document upload section, displaying supported formats and processing status.*\n",
|
||||
"\n",
|
||||
"This step ensures that your content is ready for accurate and efficient retrieval without compromising privacy.\n",
|
||||
"\n",
|
||||
"---\n",
|
||||
"\n",
|
||||
"## Querying Your Documents\n",
|
||||
"\n",
|
||||
"### Retrieving Contextually Relevant Answers\n",
|
||||
"Once your documents are processed, you can query the system by asking questions related to your content. DocuSeek AI’s RAG system retrieves precise, context-rich answers directly from your uploaded files.\n",
|
||||
"\n",
|
||||
" \n",
|
||||
"*Figure 3: The query interface, where users input questions and receive detailed, relevant responses.*\n",
|
||||
"\n",
|
||||
"This feature demonstrates the power of combining LLMs with vector search to deliver tailored responses, making it ideal for educational and professional use cases.\n",
|
||||
"\n",
|
||||
"---\n",
|
||||
"\n",
|
||||
"## Visualizing Data Relationships\n",
|
||||
"\n",
|
||||
"### Understanding Connections Within Your Documents\n",
|
||||
"**DocuSeek AI** enhances document exploration by generating interactive visualizations that reveal relationships and patterns within your data. This feature is particularly useful for identifying key concepts and their connections.\n",
|
||||
"\n",
|
||||
" \n",
|
||||
"*Figure 4: A visualization highlighting relationships and concepts extracted from the documents.*\n",
|
||||
"\n",
|
||||
"These visualizations provide a deeper understanding of your content, making complex information more accessible and actionable.\n",
|
||||
"\n",
|
||||
"---\n",
|
||||
"\n",
|
||||
"## Setup and Exploration\n",
|
||||
"\n",
|
||||
"### Experiment with DocuSeek AI\n",
|
||||
"To explore **DocuSeek AI** and its underlying technology, clone the repository from [DocuSeek AI GitHub](https://github.com/alakob/ai_private_document_retriever) and follow the setup instructions. This provides an opportunity to:\n",
|
||||
"- Experiment with RAG systems and vector search.\n",
|
||||
"- Understand LLM applications in secure document retrieval.\n",
|
||||
"- Customize the tool for specific use cases or educational projects.\n",
|
||||
"\n",
|
||||
"---\n",
|
||||
"\n",
|
||||
"### Acknowledgments\n",
|
||||
"Special thanks to Ed. Donner for his transformative [LLM Engineering course](https://www.udemy.com/course/llm-engineering-master-ai-and-large-language-models/learn/lecture/46867711#content) that inspired this project.\n"
|
||||
]
|
||||
}
|
||||
],
|
||||
"metadata": {
|
||||
"language_info": {
|
||||
"name": "python"
|
||||
}
|
||||
},
|
||||
"nbformat": 4,
|
||||
"nbformat_minor": 2
|
||||
}
|
||||
BIN
week5/community-contributions/docuSeekAI/docuseek1.png
Normal file
BIN
week5/community-contributions/docuSeekAI/docuseek1.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 82 KiB |
BIN
week5/community-contributions/docuSeekAI/docuseek2.png
Normal file
BIN
week5/community-contributions/docuSeekAI/docuseek2.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 155 KiB |
BIN
week5/community-contributions/docuSeekAI/docuseek3.png
Normal file
BIN
week5/community-contributions/docuSeekAI/docuseek3.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 102 KiB |
BIN
week5/community-contributions/docuSeekAI/docuseek4.png
Normal file
BIN
week5/community-contributions/docuSeekAI/docuseek4.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 98 KiB |
Reference in New Issue
Block a user