Add CLI wireframe

outlines/serve/main.py

@@ -0,0 +1,42 @@
+import typer
+from typing_extensions import Annotated
+
+from outlines.function import extract_function_from_file
+
+app = typer.Typer(
+ no_args_is_help=True, help="Serve Outlines functions as APIs", add_completion=False
+)
+
+
+@app.command()
+def serve(
+ path: Annotated[
+ str,
+ typer.Argument(help="Path to the script that defines the Outlines function."),
+ ],
+ name: Annotated[
+ str,
+ typer.Option("--name", "-n", help="The name of the function in the script."),
+ ] = "fn",
+ port: Annotated[
+ int,
+ typer.Option("--port", "-p", help="Port to serve the function locally"),
+ ] = 8000,
+):
+ """Serve the Outlines function."""
+
+ with open(path) as file:
+ content = file.read()
+
+ _ = extract_function_from_file(content, name)
+
+ # 1. Load the file and import objects
+ # 2. Find the function by its name
+ # 3. Create an API based on the prompt function's parameters and model name
+ # 4. Return example of calling the API
+
+ print(f"{path}{port}{name}")
+
+
+def main():
+ app()

pyproject.toml

@@ -65,6 +65,7 @@ serve = [
  "uvicorn",
  "fastapi",
  "pydantic>=2.0",
+ "typer[all]",
 ]
 
 [project.urls]
@@ -76,6 +77,9 @@ repository = "https://github.com/outlines-dev/outlines"
 file="README.md"
 content-type = "text/markdown"
 
+[project.scripts]
+outlines = "outlines.serve.main:main"
+
 [tool.setuptools]
 packages = ["outlines"]
 
@@ -95,6 +99,9 @@ filterwarnings = [
  "ignore::UserWarning",
 ]
 
+[tool.poetry.scripts]
+rick-portal-gun = "rick_portal_gun.main:app"
+
 [tool.mypy]
 exclude=["examples"]
 
@@ -117,6 +124,7 @@ module = [
  "tiktoken.*",
  "torch.*",
  "transformers.*",
+ "typer.*",
  "llama_cpp",
  "huggingface_hub",
  "lark.*",