Skip to content

sharukat/docchameleon

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

23 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

DocChameleon: Automated TensorFlow API Documentation Customizer

DocChameleon is an intelligent documentation enhancement tool that augments TensorFlow API docs using Large Language Models (LLMs) and Retrieval-Augmented Generation (RAG). It tackles common developer pain points such as missing examples, ambiguous explanations, and lack of practical learning resources by generating executable code, clarifications, and curated references from Stack Overflow and YouTube.

๐ŸŒฑ Motivation

As machine learning libraries like TensorFlow evolve rapidly, API documentation often fails to keep pace with updates, leaving developers frustrated and dependent on external sources for clarity. A deep dive into Stack Overflow questions revealed that most TensorFlow documentation-related queries stem from:

  • A lack of clear, executable code examples
  • Ambiguous or insufficient explanations
  • The absence of supporting resources or references

To bridge this gap, DocChameleon uses LLMs and RAG to enrich TensorFlow API documentation automatically. It aims to reduce friction for developers by providing:

  • Executable examples tailored to each API
  • Clearer, AI-generated explanations for confusing or undocumented behaviors
  • Curated external resources to accelerate learning and troubleshooting

๐Ÿš€ Getting Started

Prerequisites

  • OpenAI & Cohere API Keys
  • Python 3.9+

Setup

  1. Clone the repo
    git clone https://github.com/sharukat/docchameleon.git
    cd docchameleon

๐Ÿ’ป Technology Stack

About

DocChameleon enhances TensorFlow API docs using LLMs and RAG by generating executable examples, clarifying ambiguous content, and curating helpful resources from Stack Overflow and YouTube.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages