lenskit.data.movielens
======================

.. py:module:: lenskit.data.movielens

.. autoapi-nested-parse::

   Code to import MovieLens data sets into LensKit.



Attributes
----------

.. autoapisummary::

   lenskit.data.movielens.LOC


Classes
-------

.. toctree::
   :hidden:

   /api/lenskit/data/movielens/MLData
   /api/lenskit/data/movielens/ML100KLoader
   /api/lenskit/data/movielens/MLMLoader
   /api/lenskit/data/movielens/MLModernLoader

.. autoapisummary::

   lenskit.data.movielens.MLData
   lenskit.data.movielens.ML100KLoader
   lenskit.data.movielens.MLMLoader
   lenskit.data.movielens.MLModernLoader


Functions
---------

.. autoapisummary::

   lenskit.data.movielens.load_movielens
   lenskit.data.movielens.load_movielens_df



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

.. py:type:: LOC
   :canonical: Path | tuple[ZipFile, str]


.. py:function:: load_movielens(path)

   Load a MovieLens dataset.  The appropriate MovieLens format is detected
   based on the file contents.

   :Stability: Caller

   :param path: The path to the dataset, either as an unpacked directory or a zip
                file.

   :returns: The dataset.


.. py:function:: load_movielens_df(path)

   Load the ratings from a MovieLens dataset as a raw data frame.  The
   appropriate MovieLens format is detected based on the file contents.

   :Stability: Caller

   :param path: The path to the dataset, either as an unpacked directory or a zip
                file.

   :returns: The ratings, with columns ``user_id``, ``item_id``, ``rating``, and
             ``timestamp``.



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

.. py:function:: lenskit.data.movielens.get_logger

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

.. py:class:: lenskit.data.movielens.DatasetBuilder

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

.. py:class:: lenskit.data.movielens.Dataset

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