Skip to content

Commit

Permalink
Add docstrings to some submodules
Browse files Browse the repository at this point in the history
  • Loading branch information
nicholasjng committed Dec 2, 2024
1 parent 95c5d35 commit 2855385
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 2 deletions.
5 changes: 5 additions & 0 deletions src/nnbench/fixtures.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
"""
Collect values ('fixtures') by name for benchmark runs from certain files,
similarly to pytest and its ``conftest.py``.
"""

import inspect
import os
from collections.abc import Callable, Iterable
Expand Down
2 changes: 2 additions & 0 deletions src/nnbench/types/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
"""Custom types defined by ``nnbench`` for benchmarking workloads."""

from .benchmark import Benchmark, BenchmarkRecord, Parameters, State
from .interface import Interface
from .memo import Memo, cached_memo
2 changes: 1 addition & 1 deletion src/nnbench/types/benchmark.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""Type interfaces for benchmarks and benchmark collections."""
"""Types for benchmarks and records holding results of a run."""

import copy
import sys
Expand Down
2 changes: 1 addition & 1 deletion src/nnbench/types/interface.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""Type interface for the function interface"""
"""A dataclass representing a Python function interface."""

import inspect
import sys
Expand Down
2 changes: 2 additions & 0 deletions src/nnbench/types/memo.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
"""Tools for automatic, type safe efficient memoization of values in benchmark runs."""

import collections
import functools
import inspect
Expand Down

0 comments on commit 2855385

Please sign in to comment.