lenskit.data.msweb
==================

.. py:module:: lenskit.data.msweb

.. autoapi-nested-parse::

   Support for the MSWeb datasets.



Functions
---------

.. autoapisummary::

   lenskit.data.msweb.load_ms_web



Module Contents
---------------

.. py:function:: load_ms_web(path: pathlib.Path, format: Literal['dataset'] = 'dataset') -> lenskit.data._dataset.Dataset
                 load_ms_web(path: pathlib.Path, format: Literal['collection']) -> lenskit.data._collection.ItemListCollection
                 load_ms_web(path: pathlib.Path, format: Literal['dataset', 'collection'] = 'dataset') -> lenskit.data._dataset.Dataset | lenskit.data._collection.ItemListCollection

   Load the MSWeb data set.

   The Microsoft Anonymous Web data set was published by
   :cite:t:`breeseEmpiricalAnalysisPredictive1998`, and is available from the
   `UCI repository`_.

   This function can load the data either as a :class:`Dataset` (useful for
   training) or as an :class:`ItemListCollection` (for evaluation).

   .. _UCI repository: https://kdd.ics.uci.edu/databases/msweb/msweb.html

   :param path: The path to the data file (gzip-compressed).
   :param format: The type of object to load the data set into.

   :returns: The loaded MSWeb data.



Exported Aliases
----------------

.. py:function:: lenskit.data.msweb.get_logger

    Re-exported alias for :py:func:`lenskit.logging.get_logger`.

.. py:class:: lenskit.data.msweb.DatasetBuilder

    Re-exported alias for :py:class:`lenskit.data._builder.DatasetBuilder`.

.. py:class:: lenskit.data.msweb.ItemListCollection

    Re-exported alias for :py:class:`lenskit.data._collection.ItemListCollection`.

.. py:class:: lenskit.data.msweb.Dataset

    Re-exported alias for :py:class:`lenskit.data._dataset.Dataset`.