tkmlr APIリファレンス

対象ソース: tklib2.zip（解析日: 2026-08-03）。この文書はソースコードを静的解析して生成しています。

APIの読み方

パッケージ公開APIは、原則としてトップレベルの __all__ に含まれる名前です。
モジュールAPIには、公開名（先頭が _ でない関数・クラス・メソッド）を列挙しています。
docstringがないAPIでは、シグネチャとソースパスを一次情報として扱ってください。
生成AIは、この文書に存在しない引数・戻り値・メソッドを推測で追加しないでください。

パッケージ公開API

from tkmlr import (
    BaseRegressor,
    create_model,
    registered_models,
    register_model,
    regression_report,
)

名前	推奨用途
`BaseRegressor`	トップレベルから安定してimportできる公開API
`create_model`	トップレベルから安定してimportできる公開API
`registered_models`	トップレベルから安定してimportできる公開API
`register_model`	トップレベルから安定してimportできる公開API
`regression_report`	トップレベルから安定してimportできる公開API

モジュール一覧

モジュール	ソース	関数	クラス
`tkmlr`	`tkmlr/__init__.py`	0	0
`tkmlr.base`	`tkmlr/base.py`	2	1
`tkmlr.cli`	`tkmlr/cli.py`	2	0
`tkmlr.data`	`tkmlr/data.py`	4	1
`tkmlr.factory`	`tkmlr/factory.py`	0	0
`tkmlr.metrics`	`tkmlr/metrics.py`	5	0
`tkmlr.physbo_regressor`	`tkmlr/physbo_regressor.py`	1	1
`tkmlr.preprocessing`	`tkmlr/preprocessing.py`	0	2
`tkmlr.registry`	`tkmlr/registry.py`	3	0
`tkmlr.sklearn_models`	`tkmlr/sklearn_models.py`	8	1

`tkmlr`

ソース: tkmlr/__init__.py

tkmlr: small extensible regression library.

このモジュールには静的解析で検出された公開関数・クラス・定数はありません。

`tkmlr.base`

ソース: tkmlr/base.py

Base classes for tkmlr regressors.

The design follows the scikit-learn style where possible: fit(X, y) predict(X, return_std=False) get_params() set_params(**params)

Bayesian optimizers should be implemented separately. A PHYSBO Gaussian-process surrogate can live here as a regressor, while ask/tell adaptive search belongs in a separate optimizer module/package.

class `BaseRegressor`

Small sklearn-like base class.

Subclasses only need to override fit and predict. This class is kept intentionally light so that wrappers for sklearn, PHYSBO, GPy, GPflow, etc. can share the same external interface without inheriting from sklearn.

データクラス相当の初期化フィールド

BaseRegressor(supports_std: bool = False, supports_score: bool = False, name: str = 'base')

フィールド

名前	型	既定値
`supports_std`	`bool`	`False`
`supports_score`	`bool`	`False`
`name`	`str`	`'base'`

メソッド／プロパティ

method `BaseRegressor.fit`

def fit(self, X: ArrayLike, y: ArrayLike) -> 'BaseRegressor'

ソース内docstringはありません。シグネチャと実装を参照してください。

method `BaseRegressor.predict`

def predict(self, X: ArrayLike, return_std: bool = False)

ソース内docstringはありません。シグネチャと実装を参照してください。

method `BaseRegressor.get_params`

def get_params(self, deep: bool = True) -> Dict[str, Any]

ソース内docstringはありません。シグネチャと実装を参照してください。

method `BaseRegressor.set_params`

def set_params(self, **params: Any) -> 'BaseRegressor'

ソース内docstringはありません。シグネチャと実装を参照してください。

method `BaseRegressor.score`

def score(self, X: ArrayLike, y: ArrayLike) -> float

ソース内docstringはありません。シグネチャと実装を参照してください。

function `as_2d_array`

def as_2d_array(X: ArrayLike) -> np.ndarray

ソース内docstringはありません。シグネチャと実装を参照してください。

function `as_1d_array`

def as_1d_array(y: ArrayLike) -> np.ndarray

ソース内docstringはありません。シグネチャと実装を参照してください。

`tkmlr.cli`

ソース: tkmlr/cli.py

Command-line interface for tkmlr.

function `build_parser`

def build_parser() -> argparse.ArgumentParser

ソース内docstringはありません。シグネチャと実装を参照してください。

function `main`

def main(argv = None) -> int

ソース内docstringはありません。シグネチャと実装を参照してください。

`tkmlr.data`

ソース: tkmlr/data.py

Data loading and column parsing utilities.

class `TargetSpec`

ソース内docstringはありません。シグネチャと実装を参照してください。

データクラス相当の初期化フィールド

TargetSpec(original_label: str, label: str, mode: str = 'max', value: Optional[float] = None, plot_index: Optional[int] = None)

フィールド

名前	型	既定値
`original_label`	`str`	`必須`
`label`	`str`	`必須`
`mode`	`str`	`'max'`
`value`	`Optional[float]`	`None`
`plot_index`	`Optional[int]`	`None`

function `read_table`

def read_table(path: str, sheet_name = 0, header: int = 0, index_col = None) -> pd.DataFrame

ソース内docstringはありません。シグネチャと実装を参照してください。

function `parse_target_columns`

def parse_target_columns(columns: Sequence[str]) -> Tuple[List[TargetSpec], List[str]]

ソース内docstringはありません。シグネチャと実装を参照してください。

function `transform_target`

def transform_target(y: np.ndarray, spec: TargetSpec) -> np.ndarray

ソース内docstringはありません。シグネチャと実装を参照してください。

function `make_xy_from_table`

def make_xy_from_table(df: pd.DataFrame, target: Optional[str] = None, descriptors: Optional[Sequence[str]] = None, dropna: bool = True)

ソース内docstringはありません。シグネチャと実装を参照してください。

`tkmlr.factory`

ソース: tkmlr/factory.py

Public factory helpers.

このモジュールには静的解析で検出された公開関数・クラス・定数はありません。

`tkmlr.metrics`

ソース: tkmlr/metrics.py

Metrics used by tkmlr.

function `mae`

def mae(y_true, y_pred) -> float

ソース内docstringはありません。シグネチャと実装を参照してください。

function `mse`

def mse(y_true, y_pred) -> float

ソース内docstringはありません。シグネチャと実装を参照してください。

function `rmse`

def rmse(y_true, y_pred) -> float

ソース内docstringはありません。シグネチャと実装を参照してください。

function `r2`

def r2(y_true, y_pred) -> float

ソース内docstringはありません。シグネチャと実装を参照してください。

function `regression_report`

def regression_report(y_true, y_pred) -> Dict[str, float]

ソース内docstringはありません。シグネチャと実装を参照してください。

`tkmlr.physbo_regressor`

ソース: tkmlr/physbo_regressor.py

PHYSBO Gaussian-process surrogate as a regressor.

This class intentionally does not implement ask/tell adaptive learning. It is a surrogate regressor for comparing PHYSBO's GP/RFM backend with sklearn GPR and other regressors through the common tkmlr interface.

class `PhysBORegressor` — bases: `BaseRegressor`

ソース内docstringはありません。シグネチャと実装を参照してください。

データクラス相当の初期化フィールド

PhysBORegressor(score_mode: str = 'EI', num_rand_basis: int = 200, interval: int = 0, standardize: bool = True, random_seed: Optional[int] = None, name: str = 'physbo', supports_std: bool = True, supports_score: bool = True)

フィールド

名前	型	既定値
`score_mode`	`str`	`'EI'`
`num_rand_basis`	`int`	`200`
`interval`	`int`	`0`
`standardize`	`bool`	`True`
`random_seed`	`Optional[int]`	`None`
`name`	`str`	`'physbo'`
`supports_std`	`bool`	`True`
`supports_score`	`bool`	`True`

メソッド／プロパティ

method `PhysBORegressor.fit`

def fit(self, X, y)

ソース内docstringはありません。シグネチャと実装を参照してください。

method `PhysBORegressor.predict`

def predict(self, X, return_std: bool = False)

ソース内docstringはありません。シグネチャと実装を参照してください。

method `PhysBORegressor.acquisition`

def acquisition(self, X, mode: Optional[str] = None)

ソース内docstringはありません。シグネチャと実装を参照してください。

function `build_physbo`

def build_physbo(**params)

ソース内docstringはありません。シグネチャと実装を参照してください。

`tkmlr.preprocessing`

ソース: tkmlr/preprocessing.py

Preprocessing utilities for tkmlr.

class `Standardizer`

Simple standardizer independent of sklearn.

sigma=0 columns are left unchanged by using sigma=1.0.

データクラス相当の初期化フィールド

Standardizer(mean_: Optional[np.ndarray] = None, scale_: Optional[np.ndarray] = None)

フィールド

名前	型	既定値
`mean_`	`Optional[np.ndarray]`	`None`
`scale_`	`Optional[np.ndarray]`	`None`

メソッド／プロパティ

method `Standardizer.fit`

def fit(self, X: Any) -> 'Standardizer'

ソース内docstringはありません。シグネチャと実装を参照してください。

method `Standardizer.transform`

def transform(self, X: Any) -> np.ndarray

ソース内docstringはありません。シグネチャと実装を参照してください。

method `Standardizer.fit_transform`

def fit_transform(self, X: Any) -> np.ndarray

ソース内docstringはありません。シグネチャと実装を参照してください。

method `Standardizer.inverse_transform`

def inverse_transform(self, X: Any) -> np.ndarray

ソース内docstringはありません。シグネチャと実装を参照してください。

class `LogTransformer`

Column-wise log transform.

log_columns can be column names or integer column indices.

データクラス相当の初期化フィールド

LogTransformer(log_columns: Iterable[Any])

フィールド

名前	型	既定値
`log_columns`	`Iterable[Any]`	`必須`

メソッド／プロパティ

method `LogTransformer.transform_dataframe`

def transform_dataframe(self, df)

ソース内docstringはありません。シグネチャと実装を参照してください。

`tkmlr.registry`

ソース: tkmlr/registry.py

Model registry for tkmlr.

New backends can be added without editing the factory by decorating a builder:

@register_model("my_model")
def build_my_model(**params):
    return MyRegressor(**params)

function `register_model`

def register_model(name: str)

ソース内docstringはありません。シグネチャと実装を参照してください。

function `create_model`

def create_model(name: str, **params) -> BaseRegressor

ソース内docstringはありません。シグネチャと実装を参照してください。

function `registered_models`

def registered_models() -> Iterable[str]

ソース内docstringはありません。シグネチャと実装を参照してください。

`tkmlr.sklearn_models`

ソース: tkmlr/sklearn_models.py

Wrappers for sklearn regressors.

class `SklearnRegressor` — bases: `BaseRegressor`

Generic wrapper around a scikit-learn estimator.

データクラス相当の初期化フィールド

SklearnRegressor(estimator: Any, name: str = 'sklearn')

フィールド

名前	型	既定値
`estimator`	`Any`	`必須`
`name`	`str`	`'sklearn'`

メソッド／プロパティ

method `SklearnRegressor.fit`

def fit(self, X, y)

ソース内docstringはありません。シグネチャと実装を参照してください。

method `SklearnRegressor.predict`

def predict(self, X, return_std: bool = False)

ソース内docstringはありません。シグネチャと実装を参照してください。

method `SklearnRegressor.get_params`

def get_params(self, deep: bool = True)

ソース内docstringはありません。シグネチャと実装を参照してください。

method `SklearnRegressor.set_params`

def set_params(self, **params)

ソース内docstringはありません。シグネチャと実装を参照してください。

function `build_linear`

def build_linear(**params)

ソース内docstringはありません。シグネチャと実装を参照してください。

function `build_ridge`

def build_ridge(alpha: float = 1.0, **params)

ソース内docstringはありません。シグネチャと実装を参照してください。

function `build_lasso`

def build_lasso(alpha: float = 1.0, max_iter: int = 10000, **params)

ソース内docstringはありません。シグネチャと実装を参照してください。

function `build_elastic`

def build_elastic(alpha: float = 1.0, l1_ratio: float = 0.5, max_iter: int = 10000, **params)

ソース内docstringはありません。シグネチャと実装を参照してください。

function `build_mlp`

def build_mlp(hidden_layer_sizes = (20, 20), max_iter: int = 2000, random_state: Optional[int] = 0, **params)

ソース内docstringはありません。シグネチャと実装を参照してください。

function `build_random_forest`

def build_random_forest(n_estimators: int = 200, random_state: Optional[int] = 0, **params)

ソース内docstringはありません。シグネチャと実装を参照してください。

function `build_gpr`

def build_gpr(alpha: float = 1e-06, kernel: Any = None, n_restarts_optimizer: int = 5, **params)

ソース内docstringはありません。シグネチャと実装を参照してください。

function `build_svr`

def build_svr(C: float = 1.0, epsilon: float = 0.1, kernel: str = 'rbf', **params)

ソース内docstringはありません。シグネチャと実装を参照してください。

tkmlr APIリファレンス

APIの読み方

パッケージ公開API

モジュール一覧

tkmlr

tkmlr.base

class BaseRegressor

method BaseRegressor.fit

method BaseRegressor.predict

method BaseRegressor.get_params

method BaseRegressor.set_params

method BaseRegressor.score

function as_2d_array

function as_1d_array

tkmlr.cli

function build_parser

function main

tkmlr.data

class TargetSpec

function read_table

function parse_target_columns

function transform_target

function make_xy_from_table

tkmlr.factory

tkmlr.metrics

function mae

function mse

function rmse

function r2

function regression_report

tkmlr.physbo_regressor

class PhysBORegressor — bases: BaseRegressor

method PhysBORegressor.fit

method PhysBORegressor.predict

method PhysBORegressor.acquisition

function build_physbo

tkmlr.preprocessing

class Standardizer

method Standardizer.fit

method Standardizer.transform

method Standardizer.fit_transform

method Standardizer.inverse_transform

class LogTransformer

method LogTransformer.transform_dataframe

tkmlr.registry

function register_model

function create_model

function registered_models

tkmlr.sklearn_models

class SklearnRegressor — bases: BaseRegressor

method SklearnRegressor.fit

method SklearnRegressor.predict

method SklearnRegressor.get_params

method SklearnRegressor.set_params

function build_linear

function build_ridge

function build_lasso

function build_elastic

function build_mlp

function build_random_forest

function build_gpr

function build_svr

`tkmlr`

`tkmlr.base`

class `BaseRegressor`

method `BaseRegressor.fit`

method `BaseRegressor.predict`

method `BaseRegressor.get_params`

method `BaseRegressor.set_params`

method `BaseRegressor.score`

function `as_2d_array`

function `as_1d_array`

`tkmlr.cli`

function `build_parser`

function `main`

`tkmlr.data`

class `TargetSpec`

function `read_table`

function `parse_target_columns`

function `transform_target`

function `make_xy_from_table`

`tkmlr.factory`

`tkmlr.metrics`

function `mae`

function `mse`

function `rmse`

function `r2`

function `regression_report`

`tkmlr.physbo_regressor`

class `PhysBORegressor` — bases: `BaseRegressor`

method `PhysBORegressor.fit`

method `PhysBORegressor.predict`

method `PhysBORegressor.acquisition`

function `build_physbo`

`tkmlr.preprocessing`

class `Standardizer`

method `Standardizer.fit`

method `Standardizer.transform`

method `Standardizer.fit_transform`

method `Standardizer.inverse_transform`

class `LogTransformer`

method `LogTransformer.transform_dataframe`

`tkmlr.registry`

function `register_model`

function `create_model`

function `registered_models`

`tkmlr.sklearn_models`

class `SklearnRegressor` — bases: `BaseRegressor`

method `SklearnRegressor.fit`

method `SklearnRegressor.predict`

method `SklearnRegressor.get_params`

method `SklearnRegressor.set_params`

function `build_linear`

function `build_ridge`

function `build_lasso`

function `build_elastic`

function `build_mlp`

function `build_random_forest`

function `build_gpr`

function `build_svr`