Skip to content
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

updated docs to reflect last changes in main repo #62

Merged
merged 3 commits into from
Nov 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/flow-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ jobs:
run: |
mkdir -p flows_openapi
openapi_file="flows_openapi/all_flows_openapi.json"
VIX_MODE=SERVER VIX_SERVER_FULL_MODELS=0 python3 -m visionatrix openapi --only-flows --installed --file="$openapi_file"
VIX_MODE=SERVER VIX_SERVER_FULL_MODELS=0 python3 -m visionatrix openapi --flows="*" --exclude-base --file="$openapi_file"

- name: Generate HTML documentation for OpenAPI specs
if: steps.check_flows.outputs.flows_changed == 'true'
Expand Down
27 changes: 22 additions & 5 deletions docs/AdminManual/command_line_options.md
Original file line number Diff line number Diff line change
Expand Up @@ -340,16 +340,33 @@ python3 -m visionatrix [--verbose=LEVEL] openapi [options]
### Options

- `--file=FILENAME`: Filename to save. Default: `openapi.json`.
- `--available`: Include specs for 'available' flows.
- `--installed`: Include specs for 'installed' flows.
- `--indentation=SIZE`: Indentation size. Default: `2`.
- `--only-flows`: Only include specs for flows.
- `--flows=FLOWS`: Flows to include in OpenAPI specs (comma-separated list or `*`).
- If `--flows` is `*`, include all endpoints and all installed flows.
- If `--flows` is specified but empty (e.g., `--flows=""`), do not include any flows.
- If `--flows` is a comma-separated list of flow names (e.g., `--flows=flow1,flow2`), include those flows.
- `--skip-not-installed`: Skip flows that are not installed. Default: `True`.
- `--exclude-base`: Exclude base application endpoints from OpenAPI specs.
- `--backend_dir=BACKEND_DIR`: Directory for the folder with ComfyUI. Default: `vix_backend`
- `--flows_dir=FLOWS_DIR`: Directory for the flows. Default: `vix_flows`
- `--models_dir=MODELS_DIR`: Directory for the models. Default: `vix_models`

### Example
### Examples

#### Generate OpenAPI Specs for All Endpoints and All Installed Flows

```shell
python3 -m visionatrix openapi --flows="*" --file=my_openapi.json
```

#### Generate OpenAPI Specs for Specific Flows Only

```shell
python3 -m visionatrix openapi --flows=flow1,flow2 --exclude-base --file=my_openapi.json
```

#### Generate OpenAPI Specs Without Any Flows

```shell
python3 -m visionatrix openapi --available --file=my_openapi.json
python3 -m visionatrix openapi --file=my_openapi.json
```
25 changes: 25 additions & 0 deletions hardware_results/summary-2024-11-12-7900X-4070TiS-HEAVY.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"test_time": "2024/11/12",
"flows": [
{
"flow_name": "flux1_dev",
"flow_display_name": "Flux",
"test_cases": [
{
"test_case": "default",
"vram_state": "NORMAL_VRAM",
"disable_smart_memory": false,
"avg_exec_time": 69.01428131550003,
"avg_max_memory_usage": 14771.73
},
{
"test_case": "default",
"vram_state": "NORMAL_VRAM",
"disable_smart_memory": true,
"avg_exec_time": 73.96840204649993,
"avg_max_memory_usage": 14585.75
}
]
}
]
}