Skip to content

Latest commit

 

History

History
32 lines (22 loc) · 1.09 KB

File metadata and controls

32 lines (22 loc) · 1.09 KB

API reference

The repository uses generated API documentation for the code-level reference and task-oriented docs for the operational workflow.

Generated API docs

The existing generated documentation lives under docs/doxy-docs and is the source for the API reference:

Usage model

The generated docs are best used for:

  • C++ API lookup
  • Python API lookup
  • scheduler and deployment concepts
  • framework terminology and deeper implementation details

Use the task-oriented docs under docs/getting-started/ and docs/guides/ for installation and day-to-day usage.

Related documentation