Skip to content

Commit

Permalink
Changed git username, updated links
Browse files Browse the repository at this point in the history
  • Loading branch information
NicolasHug committed Nov 19, 2016
1 parent e8a1d7c commit c9701c8
Show file tree
Hide file tree
Showing 5 changed files with 43 additions and 39 deletions.
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
[![GitHub version](https://badge.fury.io/gh/Niourf%2Frecsys.svg)](https://badge.fury.io/gh/Niourf%2Frecsys)
[![GitHub
version](https://badge.fury.io/gh/nicolashug%2Frecsys.svg)](https://badge.fury.io/gh/nicolashug%2Frecsys)
[![Documentation Status](https://readthedocs.org/projects/recsys/badge/?version=latest)](http://recsys.readthedocs.io/en/latest/?badge=latest)
[![Build Status](https://travis-ci.org/Niourf/RecSys.svg?branch=master)](https://travis-ci.org/Niourf/RecSys)
[![python_versions](https://img.shields.io/badge/python-2.7%2C%203.4%2C%203.5-blue.svg)]
(https://pypi.python.org/pypi/recsys/)
[![license](https://img.shields.io/badge/license-GPLv3-blue.svg)](https://github.com/Niourf/RecSys/blob/master/LICENSE.md)
[![Build
Status](https://travis-ci.org/NicolasHug/RecSys.svg?branch=master)](https://travis-ci.org/NicolasHug/RecSys)
[![python_versions](https://img.shields.io/badge/python-2.7%2C%203.5-blue.svg)]
(https://nicolashug.github.io/RecSys/)
[![license](https://img.shields.io/badge/license-GPLv3-blue.svg)](https://github.com/NicolasHug/RecSys/blob/master/LICENSE.md)


RecSys
Expand All @@ -12,13 +14,13 @@ RecSys
Overview
--------

[RecSys](https://niourf.github.io/RecSys/) is an open source Python library
[RecSys](https://NicolasHug.github.io/RecSys/) is an open source Python library
that provides with tools to build and evaluate the performance of many
recommender system prediction algorithms. Its goal is to make life easy(-ier)
for reseachers, teachers and students who want to play around with new
recommender algorithms ideas and teach/learn more about recommender systems.

[RecSys](https://niourf.github.io/RecSys/) **was designed with the following
[RecSys](https://NicolasHug.github.io/RecSys/) **was designed with the following
purposes in mind**:

- Give the user perfect control over his experiments. To this end, a strong
Expand All @@ -36,9 +38,9 @@ purposes in mind**:
- Make it easy to implement [new algorithm
ideas](http://recsys.readthedocs.io/en/latest/building_custom_algo.html).
- Provide with tools to [evaluate](http://recsys.readthedocs.io/en/latest/evaluate.html),
[analyse](http://nbviewer.jupyter.org/github/Niourf/RecSys/tree/master/examples/notebooks/KNNBasic_analysis.ipynb/)
[analyse](http://nbviewer.jupyter.org/github/NicolasHug/RecSys/tree/master/examples/notebooks/KNNBasic_analysis.ipynb/)
and
[compare](http://nbviewer.jupyter.org/github/Niourf/RecSys/tree/master/examples/notebooks/Compare.ipynb/)
[compare](http://nbviewer.jupyter.org/github/NicolasHug/RecSys/tree/master/examples/notebooks/Compare.ipynb/)
the algorithms performance. Cross-validation procedures can be run very easily.

Installation / Usage
Expand All @@ -52,7 +54,7 @@ need numpy):
Or clone the repo and build from the sources (you'll need Cython and numpy
first):

$ git clone https://github.com/Niourf/recsys.git
$ git clone https://github.com/NicolasHug/recsys.git
$ python setup.py install

Example
Expand Down
2 changes: 1 addition & 1 deletion doc/source/building_custom_algo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -123,5 +123,5 @@ called in the ``train`` method (or anywhere else).


Feel free to explore the prediction_algorithms package `source
<https://github.com/Niourf/RecSys/tree/master/recsys/prediction_algorithms>`_
<https://github.com/NicolasHug/RecSys/tree/master/recsys/prediction_algorithms>`_
to get an idea of what can be done.
41 changes: 21 additions & 20 deletions doc/source/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Getting Started
Basic usage
-----------

`RecSys <https://github.com/Niourf/RecSys>`_ has a set of built-in
`RecSys <https://nicolashug.github.io/RecSys/>`_ has a set of built-in
:ref:`algorithms<prediction_algorithms>` and :ref:`datasets <dataset>` for you
to play with. In its simplest form, it takes about four lines of code to
evaluate the performance of an algorithm:
Expand All @@ -20,13 +20,14 @@ evaluate the performance of an algorithm:
:lines: 9-


If `RecSys <https://github.com/Niourf/RecSys>`_ cannot find the `movielens-100k
dataset <http://grouplens.org/datasets/movielens/>`_, it will offer to download
it and will store it under the ``.recsys_data`` folder in your home directory.
The :meth:`split() <recsys.dataset.DatasetAutoFolds.split>` method
automatically splits the dataset into 3 folds and the :func:`evaluate()
<recsys.evaluate.evaluate>` function runs the cross-validation procedure and
compute some :mod:`accuracy <recsys.accuracy>` measures.
If `RecSys <https://nicolashug.github.io/RecSys/>`_ cannot find the
`movielens-100k dataset <http://grouplens.org/datasets/movielens/>`_, it will
offer to download it and will store it under the ``.recsys_data`` folder in
your home directory. The :meth:`split()
<recsys.dataset.DatasetAutoFolds.split>` method automatically splits the
dataset into 3 folds and the :func:`evaluate() <recsys.evaluate.evaluate>`
function runs the cross-validation procedure and compute some :mod:`accuracy
<recsys.accuracy>` measures.


.. _load_custom:
Expand All @@ -35,7 +36,7 @@ Load a custom dataset
---------------------

You can of course use a custom dataset. `RecSys
<https://github.com/Niourf/RecSys>`_ offers two ways of loading a custom
<https://nicolashug.github.io/RecSys/>`_ offers two ways of loading a custom
dataset:

- you can either specify a single file with all the ratings and
Expand All @@ -45,8 +46,8 @@ dataset:
list of files for training and testing.

Either way, you will need to define a :class:`Reader <recsys.dataset.Reader>`
object for `RecSys <https://github.com/Niourf/RecSys>`_ to be able to parse the
file(s).
object for `RecSys <https://nicolashug.github.io/RecSys/>`_ to be able to parse
the file(s).

We'll see how to handle both cases with the `movielens-100k dataset
<http://grouplens.org/datasets/movielens/>`_. Of course this is a built-in
Expand All @@ -64,8 +65,8 @@ Load an entire dataset

.. note::
Actually, as the Movielens-100k dataset is builtin, `RecSys
<https://github.com/Niourf/RecSys>`_ provides with a proper reader so in
this case, we could have just created the reader like this: ::
<https://nicolashug.github.io/RecSys/>`_ provides with a proper reader so
in this case, we could have just created the reader like this: ::

reader = Reader('ml-100k')

Expand All @@ -91,7 +92,7 @@ Advanced usage
--------------

We will here get a little deeper on what can `RecSys
<https://github.com/Niourf/RecSys>`_ do for you.
<https://nicolashug.github.io/RecSys/>`_ do for you.

.. _iterate_over_folds:

Expand Down Expand Up @@ -156,8 +157,8 @@ will still predict the mean of all ratings :math:`\mu`.
Raw ids are ids as defined in a rating file. They can be strings or whatever.
On trainset creation, each raw id is mapped to a (unique) integer called
inner id, which is a lot more suitable for `RecSys
<https://github.com/Niourf/RecSys>`_ to manipulate. To convert a raw id to an
inner id, you can use the :meth:`to_inner_uid()
<https://nicolashug.github.io/RecSys/>`_ to manipulate. To convert a raw id
to an inner id, you can use the :meth:`to_inner_uid()
<recsys.dataset.Trainset.to_inner_uid>` and :meth:`to_inner_iid()
<recsys.dataset.Trainset.to_inner_iid>` methods of the :class:`trainset
<recsys.dataset.Trainset>`.
Expand All @@ -176,15 +177,15 @@ You may want to save your algorithm predictions along with all the usefull
information about the algorithm. This way, you can run your algorithm once,
save the results, and go back to them whenever you want to inspect in greater
details each of the predictions, and get a good insight on why your algorithm
performs well (or bad!). `RecSys <https://github.com/Niourf/RecSys>`_ provides
with some tools to do that.
performs well (or bad!). `RecSys <https://nicolashug.github.io/RecSys/>`_
provides with some tools to do that.

You can dump your algorithm predictions either using the :func:`evaluate()
<recsys.evaluate.evaluate>` function, or do it manually with the :func:`dump
<recsys.dump.dump>` function. Either way, an example is worth a thousand words,
so here a few `jupyter <http://jupyter.org/>`_ notebooks:

- `Dumping and analysis of the KNNBasic algorithm
<http://nbviewer.jupyter.org/github/Niourf/RecSys/tree/master/examples/notebooks/KNNBasic_analysis.ipynb/>`_.
<http://nbviewer.jupyter.org/github/NicolasHug/RecSys/tree/master/examples/notebooks/KNNBasic_analysis.ipynb/>`_.
- `Comparison of two algorithms
<http://nbviewer.jupyter.org/github/Niourf/RecSys/tree/master/examples/notebooks/Compare.ipynb/>`_.
<http://nbviewer.jupyter.org/github/NicolasHug/RecSys/tree/master/examples/notebooks/Compare.ipynb/>`_.
12 changes: 6 additions & 6 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@
Welcome to RecSys' documentation!
=================================

`RecSys <https://niourf.github.io/RecSys/>`_ is an open source Python library
that provides with tools to build and evaluate the performance of many
`RecSys <https://nicolashug.github.io/RecSys/>`_ is an open source Python
library that provides with tools to build and evaluate the performance of many
recommender system prediction algorithms. Its goal is to make life easy(-ier)
for reseachers, teachers and students who want to play around with new
recommender algorithms ideas and teach/learn more about recommender systems.

`RecSys <https://niourf.github.io/RecSys/>`_ was designed with the following
purposes in mind:
`RecSys <https://nicolashug.github.io/RecSys/>`_ was designed with the
following purposes in mind:

- Give the user perfect control over his experiments. To this end, a strong
emphasis is laid on :ref:`documentation <index>`, which we
Expand All @@ -31,9 +31,9 @@ purposes in mind:
- Make it easy to implement :ref:`new algorithm
ideas <building_custom_algo>`.
- Provide with tools to :func:`evaluate <recsys.evaluate.evaluate>`, `analyse
<http://nbviewer.jupyter.org/github/Niourf/RecSys/tree/master/examples/notebooks/KNNBasic_analysis.ipynb/>`_
<http://nbviewer.jupyter.org/github/NicolasHug/RecSys/tree/master/examples/notebooks/KNNBasic_analysis.ipynb/>`_
and `compare
<http://nbviewer.jupyter.org/github/Niourf/RecSys/tree/master/examples/notebooks/Compare.ipynb/>`_
<http://nbviewer.jupyter.org/github/NicolasHug/RecSys/tree/master/examples/notebooks/Compare.ipynb/>`_
the algorithms performance. Cross-validation procedures can be run very
easily.

Expand Down
5 changes: 3 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,8 @@
description=('A recommender system package aimed towards researchers ' +
'and students.'),
long_description=long_description,
url='https://github.com/Niourf/recsys',
download_url='https://github.com/Niourf/recsys/tarball/' + __version__,
url='https://github.com/NicolasHug/recsys',
download_url='https://github.com/NicolasHug/recsys/tarball/' + __version__,
license='GPLv3+',
classifiers=[
'Development Status :: 4 - Beta',
Expand All @@ -65,6 +65,7 @@
'Topic :: Scientific/Engineering',
'License :: OSI Approved',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 2',
],
keywords='',
packages=find_packages(exclude=['docs', 'tests*']),
Expand Down

0 comments on commit c9701c8

Please sign in to comment.