lenskit.data.sources.steam
==========================

.. py:module:: lenskit.data.sources.steam

.. autoapi-nested-parse::

   Support for importing `Steam data`_.

   .. _Steam data: https://cseweb.ucsd.edu/~jmcauley/datasets.html#steam_data



Attributes
----------

.. autoapisummary::

   lenskit.data.sources.steam.BATCH_SIZE
   lenskit.data.sources.steam.AU_USERS_ITEMS_SCHEMA


Functions
---------

.. autoapisummary::

   lenskit.data.sources.steam.load_steam



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

.. py:data:: BATCH_SIZE
   :value: 10000


.. py:data:: AU_USERS_ITEMS_SCHEMA

.. py:function:: load_steam(*files, reviews = False)

   Load a `Steam dataset`_ from Julian McAuley's group at UCSD.

   .. _Steam dataset: https://cseweb.ucsd.edu/~jmcauley/datasets.html#steam_data

   .. note::

       This function uses filenames to detect which version of the data to
       load, so the files should be named exactly as they are from McAuley's
       download site, optionally recompressed.

   :param files: Input files to read, in any order.  Can only load one version of
                 the data at a time (Australian or full).
   :param reviews: Set to ``True`` to include review text in the loaded dataset.



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

.. py:class:: lenskit.data.sources.steam.Dataset

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

.. py:class:: lenskit.data.sources.steam.DatasetBuilder

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

.. py:exception:: lenskit.data.sources.steam.DataError

    Re-exported alias for :py:exc:`lenskit.diagnostics.DataError`.

.. py:function:: lenskit.data.sources.steam.get_logger

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