diff --git a/src/lmql/api/query_builder.py b/src/lmql/api/query_builder.py index 70c4c19b..b16ed5be 100644 --- a/src/lmql/api/query_builder.py +++ b/src/lmql/api/query_builder.py @@ -15,6 +15,20 @@ def run_sync(self, *args, **kwargs): class QueryBuilder: + """ + Simple query builder to construct LMQL queries programatically. + + # Example usage: + query = (lmql.QueryBuilder() + .set_decoder('argmax') + .set_prompt('What is the capital of France? [ANSWER]') + .set_model('local:gpt2') + .set_where('len(TOKENS(ANSWER)) < 10') + .set_where('len(TOKENS(ANSWER)) > 2') + .build()) + + result = query.run_sync() + """ def __init__(self): self.decoder = None self.prompt = None