-
Notifications
You must be signed in to change notification settings - Fork 323
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add an interface for LLM runner #6356
Closed
+63
−1
Closed
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
/* | ||
* Copyright (c) Meta Platforms, Inc. and affiliates. | ||
* All rights reserved. | ||
* | ||
* This source code is licensed under the BSD-style license found in the | ||
* LICENSE file in the root directory of this source tree. | ||
*/ | ||
|
||
// An interface for LLM runners. Developers can create their own runner that | ||
// implements their own load and generation logic to run the model. | ||
|
||
#pragma once | ||
|
||
#include <functional> | ||
#include <string> | ||
|
||
#include <executorch/extension/llm/runner/stats.h> | ||
#include <executorch/extension/module/module.h> | ||
|
||
namespace executorch { | ||
namespace extension { | ||
namespace llm { | ||
|
||
class ET_EXPERIMENTAL IRunner { | ||
public: | ||
virtual ~IRunner() = default; | ||
|
||
// Checks if the model is loaded. | ||
virtual bool is_loaded() const = 0; | ||
|
||
// Load the model and tokenizer. | ||
virtual ::executorch::runtime::Error load() = 0; | ||
|
||
// Generate the output tokens. | ||
virtual ::executorch::runtime::Error generate( | ||
const std::string& prompt, | ||
int32_t seq_len, | ||
std::function<void(const std::string&)> token_callback = {}, | ||
std::function<void(const ::executorch::extension::llm::Stats&)> | ||
stats_callback = {}, | ||
bool echo = true, | ||
bool warming = false) = 0; | ||
|
||
// Stop the generation. | ||
virtual void stop() = 0; | ||
}; | ||
|
||
} // namespace llm | ||
} // namespace extension | ||
} // namespace executorch |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This can have a default implementation right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe not.
executorch/examples/models/llama/runner/runner.cpp
Lines 62 to 65 in 516a417
it's quite impl detail