Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

ENH: Default section for Card.add_* methods #321

Merged
merged 2 commits into from
Mar 21, 2023
Merged

ENH: Default section for Card.add_* methods #321

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1836668
ENH: Default section for add_* methods
BenjaminBossan Mar 16, 2023
745a36c
Merge branch 'main' into ENH-add-methods-default-sections
adrinjalali Mar 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/changes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ v0.6
`Benjamin Bossan`_.
- Fix: skops persistence now also works with many functions from the
:mod:`operator` module. :pr:`287` by `Benjamin Bossan`_.
- ``add_*`` methods on :class:`.Card` now have default section names (but
``None`` is no longer valid) and no longer add descriptions by default.
:pr:`321` by `Benjamin Bossan`_.

v0.5
----
Expand Down
96 changes: 26 additions & 70 deletions skops/card/_model_card.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -791,7 +791,7 @@ def _add_single(self, key: str, val: str | Section) -> Section:

def add_model_plot(
self,
section: str | None = None,
section: str = "Model description/Training Procedure/Model Plot",
description: str | None = None,
) -> Self:
"""Add a model plot
Expand All @@ -805,11 +805,10 @@ def add_model_plot(

Parameters
----------
section : str or None, default=None
The section that the model plot should be added to. If you're using
the default skops template, you can leave this parameter as
``None``, otherwise you have to indicate the section. If the section
does not exist, it will be created for you.
section : str (default="Model description/Training Procedure/Model Plot")
The section that the model plot should be added to. By default, the
section is set to fit the skops model card template. If you're using
a different template, you may have to choose a different section name.

description : str or None, default=None
An optional description to be added before the model plot. If you're
Expand All @@ -821,18 +820,8 @@ def add_model_plot(
-------
self : object
Card object.
"""
if section is None:
if self.template == Templates.skops.value:
section = "Model description/Training Procedure/Model Plot"
else:
msg = NEED_SECTION_ERR_MSG.format(action="add a model plot")
raise ValueError(msg)

if description is None:
if self.template == Templates.skops.value:
description = "The model plot is below."

"""
self._add_model_plot(
self.get_model(), section_name=section, description=description
)
Expand Down Expand Up @@ -864,17 +853,19 @@ def _add_model_plot(
self._add_single(section_name, section)

def add_hyperparams(
self, section: str | None = None, description: str | None = None
self,
section: str = "Model description/Training Procedure/Hyperparameters",
description: str | None = None,
) -> Self:
"""Add the model's hyperparameters as a table

Parameters
----------
section : str or None, default=None
The section that the hyperparamters should be added to. If you're
using the default skops template, you can leave this parameter as
``None``, otherwise you have to indicate the section. If the section
does not exist, it will be created for you.
section : str (default="Model description/Training Procedure/Hyperparameters")
The section that the hyperparameters should be added to. By default,
the section is set to fit the skops model card template. If you're
using a different template, you may have to choose a different section
name.

description : str or None, default=None
An optional description to be added before the hyperparamters. If
Expand All @@ -888,17 +879,6 @@ def add_hyperparams(
Card object.

"""
if section is None:
if self.template == Templates.skops.value:
section = "Model description/Training Procedure/Hyperparameters"
else:
msg = NEED_SECTION_ERR_MSG.format(action="add model hyperparameters")
raise ValueError(msg)

if description is None:
if self.template == Templates.skops.value:
description = "The model is trained with below hyperparameters."

self._add_hyperparams(
self.get_model(), section_name=section, description=description
)
Expand All @@ -924,7 +904,7 @@ def _add_hyperparams(

def add_get_started_code(
self,
section: str | None = None,
section: str = "How to Get Started with the Model",
description: str | None = None,
file_name: str | None = None,
model_format: Literal["pickle", "skops"] | None = None,
Expand All @@ -936,11 +916,11 @@ def add_get_started_code(

Parameters
----------
section : str or None, default=None
The section that the code should be added to. If you're using the
default skops template, you can leave this parameter as ``None``,
otherwise you have to indicate the section. If the section does not
exist, it will be created for you.
section : str (default="How to Get Started with the Model")
The section that the code for loading the model should be added to.
By default, the section is set to fit the skops model card template.
If you're using a different template, you may have to choose a
different section name.

description : str or None, default=None
An optional description to be added before the code. If you're using
Expand Down Expand Up @@ -984,17 +964,6 @@ def add_get_started_code(
if (not file_name) or (not model_format):
return self

if section is None:
if self.template == Templates.skops.value:
section = "How to Get Started with the Model"
else:
msg = NEED_SECTION_ERR_MSG.format(action="add get started code")
raise ValueError(msg)

if description is None:
if self.template == Templates.skops.value:
description = "Use the code below to get started with the model."

self._add_get_started_code(
section,
file_name=file_name,
Expand Down Expand Up @@ -1157,7 +1126,7 @@ def add_table(

def add_metrics(
self,
section: str | None = None,
section: str = "Model description/Evaluation Results",
description: str | None = None,
**kwargs: str | int | float,
) -> Self:
Expand All @@ -1167,11 +1136,10 @@ def add_metrics(

Parameters
----------
section : str or None, default=None
The section that the metrics should be added to. If you're using the
default skops template, you can leave this parameter as ``None``,
otherwise you have to indicate the section. If the section does not
exist, it will be created for you.
section : str (default="Model description/Evaluation Results")
The section that metrics should be added to. By default, the section
is set to fit the skops model card template. If you're using a
different template, you may have to choose a different section name.

description : str or None, default=None
An optional description to be added before the metrics. If you're
Expand All @@ -1186,20 +1154,8 @@ def add_metrics(
-------
self : object
Card object.
"""
if section is None:
if self.template == Templates.skops.value:
section = "Model description/Evaluation Results"
else:
msg = NEED_SECTION_ERR_MSG.format(action="add metrics")
raise ValueError(msg)

if description is None:
if self.template == Templates.skops.value:
description = (
"You can find the details about evaluation process and "
"the evaluation results."
)
"""
self._metrics.update(kwargs)
self._add_metrics(section, description=description, metrics=self._metrics)
return self
Expand Down
4 changes: 2 additions & 2 deletions skops/card/_templates.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@ class Templates(Enum):
SKOPS_TEMPLATE = {
"Model description": CONTENT_PLACEHOLDER,
"Model description/Intended uses & limitations": CONTENT_PLACEHOLDER,
"Model description/Training Procedure": "",
"Model description/Training Procedure": CONTENT_PLACEHOLDER,
"Model description/Training Procedure/Hyperparameters": CONTENT_PLACEHOLDER,
"Model description/Training Procedure/Model Plot": "The model plot is below.",
"Model description/Training Procedure/Model Plot": CONTENT_PLACEHOLDER,
"Model description/Evaluation Results": CONTENT_PLACEHOLDER,
"How to Get Started with the Model": CONTENT_PLACEHOLDER,
"Model Card Authors": (
Expand Down
Loading