base_sampler ======================================================================== .. py:module:: evalml.pipelines.components.transformers.samplers.base_sampler .. autoapi-nested-parse:: Base Sampler component. Used as the base class of all sampler components. Module Contents --------------- Classes Summary ~~~~~~~~~~~~~~~ .. autoapisummary:: evalml.pipelines.components.transformers.samplers.base_sampler.BaseSampler Contents ~~~~~~~~~~~~~~~~~~~ .. py:class:: BaseSampler(parameters=None, component_obj=None, random_seed=0, **kwargs) Base Sampler component. Used as the base class of all sampler components. :param parameters: Dictionary of parameters for the component. Defaults to None. :type parameters: dict :param component_obj: Third-party objects useful in component implementation. Defaults to None. :type component_obj: obj :param random_seed: Seed for the random number generator. Defaults to 0. :type random_seed: int **Attributes** .. list-table:: :widths: 15 85 :header-rows: 0 * - **modifies_features** - True * - **modifies_target** - True * - **training_only** - True **Methods** .. autoapisummary:: :nosignatures: evalml.pipelines.components.transformers.samplers.base_sampler.BaseSampler.clone evalml.pipelines.components.transformers.samplers.base_sampler.BaseSampler.default_parameters evalml.pipelines.components.transformers.samplers.base_sampler.BaseSampler.describe evalml.pipelines.components.transformers.samplers.base_sampler.BaseSampler.fit evalml.pipelines.components.transformers.samplers.base_sampler.BaseSampler.fit_transform evalml.pipelines.components.transformers.samplers.base_sampler.BaseSampler.load evalml.pipelines.components.transformers.samplers.base_sampler.BaseSampler.name evalml.pipelines.components.transformers.samplers.base_sampler.BaseSampler.needs_fitting evalml.pipelines.components.transformers.samplers.base_sampler.BaseSampler.parameters evalml.pipelines.components.transformers.samplers.base_sampler.BaseSampler.save evalml.pipelines.components.transformers.samplers.base_sampler.BaseSampler.transform evalml.pipelines.components.transformers.samplers.base_sampler.BaseSampler.update_parameters .. py:method:: clone(self) Constructs a new component with the same parameters and random state. :returns: A new instance of this component with identical parameters and random state. .. py:method:: default_parameters(cls) Returns the default parameters for this component. Our convention is that Component.default_parameters == Component().parameters. :returns: Default parameters for this component. :rtype: dict .. py:method:: describe(self, print_name=False, return_dict=False) Describe a component and its parameters. :param print_name: whether to print name of component :type print_name: bool, optional :param return_dict: whether to return description as dictionary in the format {"name": name, "parameters": parameters} :type return_dict: bool, optional :returns: Returns dictionary if return_dict is True, else None. :rtype: None or dict .. py:method:: fit(self, X, y) Fits the sampler to the data. :param X: Input features. :type X: pd.DataFrame :param y: Target. :type y: pd.Series :returns: self :raises ValueError: If y is None. .. py:method:: fit_transform(self, X, y) Fit and transform data using the sampler component. :param X: The input training data of shape [n_samples, n_features]. :type X: pd.DataFrame :param y: The target training data of length [n_samples]. :type y: pd.Series, optional :returns: Transformed data. :rtype: (pd.DataFrame, pd.Series) .. py:method:: load(file_path) :staticmethod: Loads component at file path. :param file_path: Location to load file. :type file_path: str :returns: ComponentBase object .. py:method:: name(cls) :property: Returns string name of this component. .. py:method:: needs_fitting(self) Returns boolean determining if component needs fitting before calling predict, predict_proba, transform, or feature_importances. This can be overridden to False for components that do not need to be fit or whose fit methods do nothing. :returns: True. .. py:method:: parameters(self) :property: Returns the parameters which were used to initialize the component. .. py:method:: save(self, file_path, pickle_protocol=cloudpickle.DEFAULT_PROTOCOL) Saves component at file path. :param file_path: Location to save file. :type file_path: str :param pickle_protocol: The pickle data stream format. :type pickle_protocol: int .. py:method:: transform(self, X, y=None) Transforms the input data by sampling the data. :param X: Training features. :type X: pd.DataFrame :param y: Target. :type y: pd.Series :returns: Transformed features and target. :rtype: pd.DataFrame, pd.Series .. py:method:: update_parameters(self, update_dict, reset_fit=True) Updates the parameter dictionary of the component. :param update_dict: A dict of parameters to update. :type update_dict: dict :param reset_fit: If True, will set `_is_fitted` to False. :type reset_fit: bool, optional