Skip to content
This repository was archived by the owner on Aug 25, 2024. It is now read-only.

Commit 6a1c48c

Browse files
authored
docs: tutorials: models: slr: Document that hyperparameters live in model config
Related: #1352
1 parent b168af5 commit 6a1c48c

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

docs/tutorials/models/slr.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,9 @@ Anything that a user might want to tweak about a models behavior should go in
6262
the ``Config`` class for the model. The naming convention is ``TheName`` +
6363
``Model`` + ``Config``.
6464

65+
Hyperparameters for a model should live inside the model's config. Ideally at
66+
the top level and not nested within another structure.
67+
6568
Our model has three configurable properties.
6669

6770
- ``features``. A list of :py:class:`Feature <dffml.feature.Feature>` objects

0 commit comments

Comments
 (0)