add docs

Author: mjun0812

.gitignore

@@ -337,4 +337,7 @@ result/*
 
 dataset/*
 !dataset/.gitkeep
-.claude
+.claude
+
+doc/docs/build/
+doc/docs/api/

doc/docs/conf.py

@@ -0,0 +1,58 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+import sys
+from pathlib import Path
+
+sys.path.insert(0, str(Path("../../src").resolve()))
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "PyTorch-Project-Template"
+copyright = "2025, Junya Morioka"
+author = "Junya Morioka"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "myst_parser",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.napoleon",
+    "autoapi.extension",
+]
+
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+language = "en"
+
+# -- Options for HTML output -----------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "furo"
+
+# -- Options for autodoc --------------------------------------------------
+autodoc_typehints = "signature"
+
+# -- Options for viewcode --------------------------------------------------
+viewcode_follow_imported_members = True
+
+# -- Options for autoapi ---------------------------------------------------
+autoapi_type = "python"
+autoapi_dirs = ["../../src"]
+autoapi_root = "api"
+autoapi_keep_files = True
+autoapi_python_class_content = "init"
+autoapi_options = [
+    "members",
+    "undoc-members",
+    "private-members",
+    "show-inheritance",
+    "show-module-summary",
+    "imported-members",
+]

doc/docs/index.md

@@ -0,0 +1,8 @@
+# PyTorch-Project-Template
+
+```{toctree}
+:caption: 'API Reference'
+:maxdepth: 3
+
+api/src/index
+```

pyproject.toml

@@ -25,6 +25,16 @@ dependencies = [
     "timm>=1.0.15",
 ]
 
+[dependency-groups]
+doc = [
+    "furo>=2024.8.6",
+    "myst-parser>=4.0.1",
+    "sphinx>=8.2.3",
+    "sphinx-autoapi>=3.6.0",
+    "sphinx-autobuild>=2024.10.3",
+]
+dev = ["mypy>=1.16.0", "pre-commit>=4.2.0", "pytest>=8.3.2", "ruff>=0.6.2"]
+
 [build-system]
 requires = ["hatchling"]
 build-backend = "hatchling.build"
@@ -37,12 +47,7 @@ typeCheckingMode = "off"
 exclude = ["dataset", "result", ".tmp", ".git", ".venv", ".vscode"]
 
 [tool.uv]
-dev-dependencies = [
-    "mypy>=1.16.0",
-    "pre-commit>=4.2.0",
-    "pytest>=8.3.2",
-    "ruff>=0.6.2",
-]
+default-groups = "all"
 
 [tool.uv.sources]
 torch = [

script/run_docs.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+DOC_DIR=./doc/docs
+PACKAGE_DIR=./src
+
+rm -rf $DOC_DIR/api $DOC_DIR/build
+
+# Run live server with watch on source code directory
+sphinx-autobuild -b html $DOC_DIR $DOC_DIR/build --port 38000 --watch $PACKAGE_DIR

src/models/base.py

@@ -12,6 +12,14 @@ class BaseModel(nn.Module):
     def __init__(
         self, cfg: dict | None, cfg_loss: dict | None = None, phase: PhaseStr = "train"
     ) -> None:
+        """
+        Base model class.
+
+        Args:
+            cfg: Configuration dictionary.
+            cfg_loss: Configuration dictionary for loss.
+            phase: Phase of the model. (train, val, test)
+        """
         super().__init__()
         self.cfg = cfg
         self.cfg_loss = cfg_loss