ggml-org/llama.cpp

Refactor: Existing examples refactoring opportunities

Open

#7,559 opened on May 27, 2024

View on GitHub
 (0 comments) (2 reactions) (0 assignees)C++ (18,202 forks)batch import
help wantedrefactoring

Repository metrics

Stars
 (110,169 stars)
PR merge metrics
 (Avg merge 6d 8h) (389 merged PRs in 30d)

Description

GG in this PR was suggesting a refactoring of examples and provided an example of what he would like to refactor. This is a ticket to inform others about opportunities to improve examples

I think a bigger advantage would be to do some refactoring in the existing examples and "hide" some of the state for sampling and KV cache management that we expose behind the common API

If there is any other aspect of the example which is currently a pain point for developer grokking, feel free to also suggest some so it can be added here.

Contributor guide

Research direction
Investigate the existing examples for refactoring opportunities as suggested in the linked PR comment. Focus on hiding sampling state and abstracting KV cache management behind the common API. Also consider restructuring help messages.
Tech stack
cpp
Domain
backend
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Needs investigation
Prerequisites
C++
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35