shaoxiongduan
0b605d0a41
Several scaffolds that pre-date the runner refactor still pointed at removed APIs: * ``EvalResult`` (and its ``Evaluator.evaluate_dataset`` docstring) exposed a class that is never returned anywhere; drop it from the public API. * ``Evaluator``'s module docstring still referenced the removed ``EvalRunner`` layer; trim to the current Evaluator → EvalWorker shape. * ``WM_EVAL_CACHE`` survived as a fallback env var from the wm-eval port; remove and keep only ``FASTVIDEO_EVAL_CACHE``. * The contributor docs documented ``batch_unit`` and ``trial_forward``/``Evaluator.calibrate()`` which were dropped from ``BaseMetric`` in earlier refactors; update to the current contract.
FastVideo Documentation
This directory contains the FastVideo documentation built with MkDocs.
Build the docs locally
# Install dependencies
pip install -r requirements-mkdocs.txt
# Serve docs with live reload (recommended for development)
mkdocs serve
# Or build static site
mkdocs build
View the docs
Development server (with live reload)
mkdocs serve
Then open your browser to: http://127.0.0.1:8000
Static build
mkdocs build
python -m http.server -d site/
Then open your browser to: http://localhost:8000
Automatic Deployment
Documentation is automatically built and deployed to GitHub Pages when changes are pushed to the main branch via the .github/workflows/infra-docs.yml workflow.