Skip to content

docs: add godoc to tensor, compute, graph, and utility packages - #2

Merged
dndungu merged 4 commits into
mainfrom
docs/api-audit-2026-03-16
Mar 17, 2026
Merged

docs: add godoc to tensor, compute, graph, and utility packages#2
dndungu merged 4 commits into
mainfrom
docs/api-audit-2026-03-16

Conversation

@dndungu

Copy link
Copy Markdown
Contributor

Summary

  • Add godoc comments to exported API surface in tensor package
  • Add godoc to Engine interface implementations in compute package
  • Add godoc to Graph and Node types in graph package
  • Add godoc to numeric, log, metrics, and testing packages

Context

Stranded work from API audit session on 2026-03-16. Commits were pushed but no PR was created.

Add godoc comments to all exported methods on Q4KStorage, Q5KStorage,
and Q6KStorage types (Len, Slice, Set, DeviceType, Dequantize).
Add godoc comments to all exported methods on EngineProxy, CPUEngine,
GPUEngine, ROCmEngine, and OpenCLEngine that implement the Engine[T]
interface. Comments describe the operation each method performs.
Add godoc comments to preTransposedNode methods (OpType, Attributes,
OutputShape, Parameters, Forward, Backward).
Add godoc comments to all exported methods on BFloat16Ops, nopLogger,
nopCollector, nopMetric, and MockEngine types.
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

@dndungu