-
Notifications
You must be signed in to change notification settings - Fork 16
Expand file tree
/
Copy pathcli.py
More file actions
447 lines (394 loc) · 17.5 KB
/
cli.py
File metadata and controls
447 lines (394 loc) · 17.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
"""
Command-line interface for Eval Protocol.
"""
import argparse
import logging
import os
import sys
from pathlib import Path
from fireworks import Fireworks
from .cli_commands.common import setup_logging
from .cli_commands.utils import add_args_from_callable_signature
logger = logging.getLogger(__name__)
def build_parser() -> argparse.ArgumentParser:
"""Build and return the argument parser for the CLI."""
parser = argparse.ArgumentParser(
description="Inspect evaluation runs locally, upload evaluators, and create reinforcement fine-tuning jobs on Fireworks"
)
return _configure_parser(parser)
def _configure_parser(parser: argparse.ArgumentParser) -> argparse.ArgumentParser:
"""Configure all arguments and subparsers on the given parser."""
parser.add_argument("--verbose", "-v", action="store_true", help="Enable verbose logging")
parser.add_argument(
"--server",
help="Fireworks API server hostname or URL (e.g., dev.api.fireworks.ai or https://dev.api.fireworks.ai)",
)
subparsers = parser.add_subparsers(dest="command", help="Command to run")
# Logs command
logs_parser = subparsers.add_parser("logs", help="Serve logs with file watching and real-time updates")
logs_parser.add_argument("--port", type=int, default=8000, help="Port to bind to (default: 8000)")
logs_parser.add_argument("--debug", action="store_true", help="Enable debug mode")
logs_parser.add_argument("--disable-elasticsearch-setup", action="store_true", help="Disable Elasticsearch setup")
logs_parser.add_argument(
"--use-env-elasticsearch-config",
action="store_true",
help="Use env vars for Elasticsearch config (requires ELASTICSEARCH_URL, ELASTICSEARCH_API_KEY, ELASTICSEARCH_INDEX_NAME)",
)
logs_parser.add_argument(
"--use-fireworks",
action="store_true",
help="Force Fireworks tracing backend for logs UI (overrides env auto-detection)",
)
logs_parser.add_argument(
"--use-elasticsearch",
action="store_true",
help="Force Elasticsearch backend for logs UI (overrides env auto-detection)",
)
# Upload command
upload_parser = subparsers.add_parser(
"upload",
help="Scan for evaluation tests, select, and upload as Fireworks evaluators",
)
# CLI workflow flags (not part of the SDK create() signature)
upload_parser.add_argument(
"--path",
default=".",
help="Path to search for evaluation tests (default: current directory)",
)
upload_parser.add_argument(
"--entry",
help="Entrypoint of evaluation test to upload (module:function or path::function). For multiple, separate by commas.",
)
upload_parser.add_argument(
"--yes",
"-y",
action="store_true",
help="Non-interactive: upload all discovered evaluation tests",
)
upload_parser.add_argument(
"--env-file",
help="Path to .env file containing secrets to upload (default: .env in current directory)",
)
# Auto-generate flags from SDK Fireworks().evaluators.create() signature
# Note: We use Fireworks() directly here instead of create_fireworks_client()
# because we only need the method signature for introspection, not a fully
# authenticated client. create_fireworks_client() would trigger an HTTP request
# to verify the API key, causing delays even for --help invocations.
create_evaluator_fn = Fireworks().evaluators.create
upload_skip_fields = {
"__top_level__": {
"account_id", # auto-detected
"extra_headers",
"extra_query",
"extra_body",
"timeout",
},
"evaluator": {
"commit_hash", # should be auto-detected from git
"source", # not relevant for CLI flow
},
}
upload_aliases = {
"evaluator_id": ["--id"],
"evaluator.display_name": ["--name"],
}
upload_help_overrides = {
"evaluator_id": "Evaluator ID to use (if multiple selections, a numeric suffix is appended)",
"evaluator.display_name": "Display name for evaluator (defaults to ID)",
"evaluator.description": "Description for evaluator",
"evaluator.requirements": "Requirements for evaluator (auto-detected from requirements.txt if not provided)",
"evaluator.entry_point": "Pytest-style entrypoint (e.g., test_file.py::test_func). Auto-detected if not provided.",
"evaluator.default_dataset": "Default dataset to use with this evaluator",
}
add_args_from_callable_signature(
upload_parser,
create_evaluator_fn,
skip_fields=upload_skip_fields,
aliases=upload_aliases,
help_overrides=upload_help_overrides,
)
# Create command group
create_parser = subparsers.add_parser(
"create",
help="Resource creation commands",
)
create_subparsers = create_parser.add_subparsers(dest="create_command")
rft_parser = create_subparsers.add_parser(
"rft",
help="Create a Reinforcement Fine-tuning Job on Fireworks",
)
rft_parser.add_argument("--yes", "-y", action="store_true", help="Non-interactive mode")
rft_parser.add_argument("--dry-run", action="store_true", help="Print planned SDK call without sending")
rft_parser.add_argument("--skip-validation", action="store_true", help="Skip local dataset/evaluator validation")
rft_parser.add_argument(
"--ignore-docker",
action="store_true",
help="Ignore Dockerfile even if present; run pytest on host during evaluator validation",
)
rft_parser.add_argument(
"--docker-build-extra",
default="",
metavar="",
help="Extra flags to pass to 'docker build' when validating evaluator (quoted string, e.g. \"--no-cache --pull --progress=plain\")",
)
rft_parser.add_argument(
"--docker-run-extra",
default="",
metavar="",
help="Extra flags to pass to 'docker run' when validating evaluator (quoted string, e.g. \"--env-file .env --memory=8g\")",
)
# The flags below are Eval Protocol CLI workflow controls (not part of the Fireworks SDK `create()` signature),
# so they can’t be auto-generated via signature introspection and must be maintained here.
rft_parser.add_argument(
"--source-job",
metavar="",
help="The source reinforcement fine-tuning job to copy configuration from. If other flags are set, they will override the source job's configuration.",
)
rft_parser.add_argument(
"--quiet",
action="store_true",
help="If set, only errors will be printed.",
)
skip_fields = {
"__top_level__": {
"extra_headers",
"extra_query",
"extra_body",
"timeout",
"display_name",
"account_id",
},
"training_config": {"region", "jinja_template"},
"wandb_config": {"run_id"},
}
aliases = {
"wandb_config.api_key": ["--wandb-api-key"],
"wandb_config.project": ["--wandb-project"],
"wandb_config.entity": ["--wandb-entity"],
"wandb_config.enabled": ["--wandb"],
"reinforcement_fine_tuning_job_id": ["--job-id"],
"loss_config.kl_beta": ["--rl-kl-beta"],
"loss_config.method": ["--rl-loss-method"],
"node_count": ["--nodes"],
}
help_overrides = {
"training_config.gradient_accumulation_steps": "The number of batches to accumulate gradients before updating the model parameters. The effective batch size will be batch-size multiplied by this value.",
"training_config.learning_rate_warmup_steps": "The number of learning rate warmup steps for the reinforcement fine-tuning job.",
"mcp_server": "The MCP server resource name to use for the reinforcement fine-tuning job. (Optional)",
"loss_config.method": "RL loss method for underlying trainers. One of {grpo,dapo}.",
}
# Note: We use Fireworks() directly here instead of create_fireworks_client()
# because we only need the method signature for introspection, not a fully
# authenticated client. create_fireworks_client() would trigger an HTTP request
# to verify the API key, causing delays even for --help invocations.
create_rft_job_fn = Fireworks().reinforcement_fine_tuning_jobs.create
add_args_from_callable_signature(
rft_parser,
create_rft_job_fn,
skip_fields=skip_fields,
aliases=aliases,
help_overrides=help_overrides,
)
# Create evj (Evaluation Job) subcommand
evj_parser = create_subparsers.add_parser(
"evj",
help="Create an Evaluation Job on Fireworks",
)
evj_parser.add_argument("--yes", "-y", action="store_true", help="Non-interactive mode")
evj_parser.add_argument("--dry-run", action="store_true", help="Print planned SDK call without sending")
evj_parser.add_argument("--skip-validation", action="store_true", help="Skip local dataset/evaluator validation")
evj_parser.add_argument(
"--ignore-docker",
action="store_true",
help="Ignore Dockerfile even if present; run pytest on host during evaluator validation",
)
evj_parser.add_argument(
"--docker-build-extra",
default="",
metavar="",
help="Extra flags to pass to 'docker build' when validating evaluator (quoted string, e.g. \"--no-cache --pull --progress=plain\")",
)
evj_parser.add_argument(
"--docker-run-extra",
default="",
metavar="",
help="Extra flags to pass to 'docker run' when validating evaluator (quoted string, e.g. \"--env-file .env --memory=8g\")",
)
evj_parser.add_argument(
"--quiet",
action="store_true",
help="If set, only errors will be printed.",
)
# Auto-generate flags from SDK Fireworks().evaluation_jobs.create() signature
create_evj_fn = Fireworks().evaluation_jobs.create
evj_skip_fields = {
"__top_level__": {
"account_id", # auto-detected
"extra_headers",
"extra_query",
"extra_body",
"timeout",
},
"evaluation_job": {
"output_stats", # read-only, set by server
},
}
evj_aliases = {
"evaluation_job_id": ["--job-id"],
"evaluation_job.evaluator": ["--evaluator"],
"evaluation_job.input_dataset": ["--dataset"], # --input-dataset is auto-added
"evaluation_job.display_name": ["--name"],
# output_dataset, evaluator_version get their short forms auto-added
}
evj_help_overrides = {
"evaluation_job_id": "Evaluation Job ID to use",
"evaluation_job.evaluator": "Evaluator resource name (format: accounts/{account_id}/evaluators/{evaluator_id})",
"evaluation_job.input_dataset": "Input dataset resource name (format: accounts/{account_id}/datasets/{dataset_id})",
"evaluation_job.output_dataset": "Output dataset resource name where results will be written",
"evaluation_job.display_name": "Display name for the evaluation job",
"evaluation_job.evaluator_version": "Specific evaluator version to use (defaults to current version)",
"leaderboard_ids": "Optional leaderboard IDs to attach this job to upon creation",
}
add_args_from_callable_signature(
evj_parser,
create_evj_fn,
skip_fields=evj_skip_fields,
aliases=evj_aliases,
help_overrides=evj_help_overrides,
)
# Local test command
local_test_parser = subparsers.add_parser(
"local-test",
help="Select an evaluation test and run it locally. If a Dockerfile exists, build and run via Docker; otherwise run on host.",
)
local_test_parser.add_argument(
"--entry",
help="Entrypoint to run (path::function or path). If not provided, a selector will be shown (unless --yes).",
)
local_test_parser.add_argument(
"--ignore-docker",
action="store_true",
help="Ignore Dockerfile even if present; run pytest on host",
)
local_test_parser.add_argument(
"--yes",
"-y",
action="store_true",
help="Non-interactive: if multiple tests exist and no --entry, fails with guidance",
)
local_test_parser.add_argument(
"--docker-build-extra",
default="",
help="Extra flags to pass to 'docker build' (quoted string, e.g. \"--no-cache --pull --progress=plain\")",
)
local_test_parser.add_argument(
"--docker-run-extra",
default="",
help="Extra flags to pass to 'docker run' (quoted string, e.g. \"--env-file .env --memory=8g\")",
)
# Hidden command: export-docs (for generating CLI reference documentation)
export_docs_parser = subparsers.add_parser("export-docs", help=argparse.SUPPRESS)
export_docs_parser.add_argument(
"--output",
"-o",
default="./docs/cli-reference.md",
help="Output markdown file path (default: ./docs/cli-reference.md)",
)
# Update metavar to only show visible commands (exclude those with SUPPRESS)
_hide_suppressed_subparsers(parser)
return parser
def _hide_suppressed_subparsers(parser: argparse.ArgumentParser) -> None:
"""Update subparsers to exclude commands with help=SUPPRESS from help output."""
for action in parser._actions:
if isinstance(action, argparse._SubParsersAction):
# Filter _choices_actions to only visible commands
choices_actions = getattr(action, "_choices_actions", [])
visible_actions = [a for a in choices_actions if a.help != argparse.SUPPRESS]
action._choices_actions = visible_actions
# Update metavar to match
visible_names = [a.dest for a in visible_actions]
if visible_names:
action.metavar = "{" + ",".join(visible_names) + "}"
def parse_args(args=None):
"""Parse command line arguments."""
parser = build_parser()
# Fail fast on unknown flags so typos don't silently get ignored.
parsed, remaining = parser.parse_known_args(args)
if remaining:
parser.error(f"unrecognized arguments: {' '.join(remaining)}")
return parsed, remaining
def main():
"""Main entry point for the CLI"""
try:
from dotenv import load_dotenv
# .env.dev for development-specific overrides, .env for general
# Use explicit paths to avoid find_dotenv() searching up the directory tree
# and potentially finding a different .env file (e.g., in some other repo)
load_dotenv(dotenv_path=Path(".") / ".env.dev", override=True)
load_dotenv(dotenv_path=Path(".") / ".env", override=True)
except ImportError:
pass
# Automatic PYTHONPATH enhancement - add current directory to Python path
# This needs to happen early, before any module loading occurs
current_dir = os.getcwd()
current_pythonpath = os.environ.get("PYTHONPATH", "")
if current_dir not in current_pythonpath.split(os.pathsep):
if current_pythonpath:
os.environ["PYTHONPATH"] = f"{current_dir}{os.pathsep}{current_pythonpath}"
else:
os.environ["PYTHONPATH"] = current_dir
logger.debug("Added current directory to PYTHONPATH: %s", current_dir)
# Also add to sys.path so it takes effect immediately for the current process
if current_dir not in sys.path:
sys.path.insert(0, current_dir)
# Pre-scan raw argv for global flags anywhere (before parsing or imports)
raw_argv = sys.argv[1:]
def _extract_flag_value(argv_list, flag_name):
# Supports --flag value and --flag=value
for i, tok in enumerate(argv_list):
if tok == flag_name:
if i + 1 < len(argv_list):
return argv_list[i + 1]
elif tok.startswith(flag_name + "="):
return tok.split("=", 1)[1]
return None
pre_server = _extract_flag_value(raw_argv, "--server")
# Handle Fireworks server selection early
server = pre_server
if server:
# Normalize to full URL if just a hostname is supplied
normalized = server.strip()
if not normalized.startswith("http://") and not normalized.startswith("https://"):
normalized = f"https://{normalized}"
os.environ["FIREWORKS_API_BASE"] = normalized
logger.debug("Using Fireworks API base: %s", normalized)
# Now parse args normally (so help/commands work), after globals applied
args, _ = parse_args()
setup_logging(args.verbose, getattr(args, "debug", False))
if args.command == "logs":
from .cli_commands.logs import logs_command
return logs_command(args)
elif args.command == "upload":
from .cli_commands.upload import upload_command
return upload_command(args)
elif args.command == "create":
if args.create_command == "rft":
from .cli_commands.create_rft import create_rft_command
return create_rft_command(args)
elif args.create_command == "evj":
from .cli_commands.create_evj import create_evj_command
return create_evj_command(args)
print("Error: missing subcommand for 'create'. Try: eval-protocol create rft|evj")
return 1
elif args.command == "local-test":
from .cli_commands.local_test import local_test_command
return local_test_command(args)
elif args.command == "export-docs":
from .cli_commands.export_docs import export_docs_command
return export_docs_command(args)
else:
parser = build_parser()
parser.print_help()
return 1
if __name__ == "__main__":
sys.exit(main())