Skip to content

[Feature] Meaningful Code Summaries using Gen AI #1065

@parinaB

Description

@parinaB

Problem Statement

The summary field in the /explanation/ endpoint is generated from a hardcoded template and looks like this:

"A short Python snippet (5 lines) that performs a focused task."

The engine never actually reads the code — it just fills in line count into a fixed string. This gives developers zero useful information about what their code actually does, which defeats the entire purpose of the explanation endpoint.

Proposed Solution

Implement a three-tier summarization system with graceful fallback:
Tier 1 — Gen AI (Best quality, requires API key)
When LLM_ENABLED=true, route the summary through the existing ai_provider.py abstraction layer with a focused prompt

Alternatives Considered

Offline NLP model (Good quality, no API key)

When NLP_ENABLED=true, use a BART or T5 model fine-tuned on CodeSearchNet for offline code-to-text summarization:

Metadata

Metadata

Assignees

Labels

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions