Skip to content

Commit 4532bab

Browse files
authored
Merge pull request #4 from FasterAI-Labs/fix/library-cleanup-v2
fix: library cleanup — dead links, notebook structure, report notebook
2 parents a35ddcd + 00127c9 commit 4532bab

26 files changed

Lines changed: 1027 additions & 99 deletions

fasterbench/_modidx.py

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,40 @@
9696
'fasterbench/profiling.py'),
9797
'fasterbench.profiling._tensor_bytes': ( 'analysis/profiling.html#_tensor_bytes',
9898
'fasterbench/profiling.py')},
99+
'fasterbench.report': { 'fasterbench.report.ComparisonReport': ( 'analysis/report.html#comparisonreport',
100+
'fasterbench/report.py'),
101+
'fasterbench.report.ComparisonReport.__init__': ( 'analysis/report.html#comparisonreport.__init__',
102+
'fasterbench/report.py'),
103+
'fasterbench.report.ComparisonReport.as_dict': ( 'analysis/report.html#comparisonreport.as_dict',
104+
'fasterbench/report.py'),
105+
'fasterbench.report.ComparisonReport.deltas': ( 'analysis/report.html#comparisonreport.deltas',
106+
'fasterbench/report.py'),
107+
'fasterbench.report.ComparisonReport.summary': ( 'analysis/report.html#comparisonreport.summary',
108+
'fasterbench/report.py'),
109+
'fasterbench.report.ComparisonReport.to_html': ( 'analysis/report.html#comparisonreport.to_html',
110+
'fasterbench/report.py'),
111+
'fasterbench.report.ComparisonReport.to_markdown': ( 'analysis/report.html#comparisonreport.to_markdown',
112+
'fasterbench/report.py'),
113+
'fasterbench.report.ComparisonReport.top_improvements': ( 'analysis/report.html#comparisonreport.top_improvements',
114+
'fasterbench/report.py'),
115+
'fasterbench.report.Report': ('analysis/report.html#report', 'fasterbench/report.py'),
116+
'fasterbench.report.Report.__init__': ('analysis/report.html#report.__init__', 'fasterbench/report.py'),
117+
'fasterbench.report.Report.as_dict': ('analysis/report.html#report.as_dict', 'fasterbench/report.py'),
118+
'fasterbench.report.Report.summary': ('analysis/report.html#report.summary', 'fasterbench/report.py'),
119+
'fasterbench.report.Report.to_html': ('analysis/report.html#report.to_html', 'fasterbench/report.py'),
120+
'fasterbench.report.Report.to_markdown': ( 'analysis/report.html#report.to_markdown',
121+
'fasterbench/report.py'),
122+
'fasterbench.report.ReportMetricDelta': ( 'analysis/report.html#reportmetricdelta',
123+
'fasterbench/report.py'),
124+
'fasterbench.report.ReportMetricDelta.as_dict': ( 'analysis/report.html#reportmetricdelta.as_dict',
125+
'fasterbench/report.py'),
126+
'fasterbench.report._extract_metrics': ( 'analysis/report.html#_extract_metrics',
127+
'fasterbench/report.py'),
128+
'fasterbench.report._format_value_with_unit': ( 'analysis/report.html#_format_value_with_unit',
129+
'fasterbench/report.py'),
130+
'fasterbench.report._generate_css': ('analysis/report.html#_generate_css', 'fasterbench/report.py'),
131+
'fasterbench.report._improvement_indicator': ( 'analysis/report.html#_improvement_indicator',
132+
'fasterbench/report.py')},
99133
'fasterbench.size': { 'fasterbench.size.SizeMetrics': ('metrics/size.html#sizemetrics', 'fasterbench/size.py'),
100134
'fasterbench.size.SizeMetrics.as_dict': ('metrics/size.html#sizemetrics.as_dict', 'fasterbench/size.py'),
101135
'fasterbench.size.compute_size': ('metrics/size.html#compute_size', 'fasterbench/size.py'),

fasterbench/benchmark.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
"""Unified benchmarking API for comprehensive model analysis"""
2-
31
# AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/analysis/benchmark.ipynb.
42

53
# %% ../nbs/analysis/benchmark.ipynb #bbaee268

fasterbench/compute.py

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
1-
"""Compute modules for benchmarking"""
2-
31
# AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/metrics/compute.ipynb.
42

53
# %% ../nbs/metrics/compute.ipynb #0091d170
64
from __future__ import annotations
75

86
import warnings
97
from dataclasses import dataclass
10-
from typing import Any
118

129
import torch
1310
import torch.nn as nn

fasterbench/core.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
"""Core modules for benchmarking"""
2-
31
# AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/core/core.ipynb.
42

53
# %% ../nbs/core/core.ipynb #c59316b7

fasterbench/energy.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
"""Energy modules for benchmarking"""
2-
31
# AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/metrics/energy.ipynb.
42

53
# %% ../nbs/metrics/energy.ipynb #d27f26a4

fasterbench/memory.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
"""Memory modules for benchmarking"""
2-
31
# AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/metrics/memory.ipynb.
42

53
# %% ../nbs/metrics/memory.ipynb #16cd91b6

fasterbench/plot.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
"""A module to plot the results of the benchmark"""
2-
31
# AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/visualization/plot.ipynb.
42

53
# %% ../nbs/visualization/plot.ipynb #0c86ca8f-38d2-44d0-8204-3c977f1b1c19

fasterbench/profiling.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
"""Per-layer profiling for deep analysis of model performance"""
2-
31
# AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/analysis/profiling.ipynb.
42

53
# %% ../nbs/analysis/profiling.ipynb #imports

fasterbench/size.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
"""Model size and parameter count measurement"""
2-
31
# AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/metrics/size.ipynb.
42

53
# %% ../nbs/metrics/size.ipynb #4c37777e

fasterbench/speed.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
"""Latency and throughput measurement for PyTorch models"""
2-
31
# AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/metrics/speed.ipynb.
42

53
# %% ../nbs/metrics/speed.ipynb #e6b40d9e

0 commit comments

Comments
 (0)