Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 74 lines (50 sloc) 3.208 kB
1ea7ef7 Improving README and adding .gigignore file
Rodrigo Alves Vieira authored
1 # Crab - A Recommendation Engine library for Python
2
3 Crab is a flexible, fast recommender engine for Python that integrates classic information filtering recom-
4 mendation algorithms in the world of scientific Python packages (numpy, scipy, matplotlib). The engine aims
5 to provide a rich set of components from which you can construct a customized recommender system from a
6 set of algorithms.
7
8 ## Usage
9
10 For Usage and Instructions checkout the [Crab Wiki](https://github.com/muricoca/crab/wiki)
11
12 ## History
13
14 The project was started in 2010 by Marcel Caraciolo as a M.S.C related project, and since then many people interested joined to help in the project.
941b5be Fixing typo in README
Rodrigo Alves Vieira authored
15 It is currently maintained by a team of volunteers, members of the Muriçoca Labs.
1ea7ef7 Improving README and adding .gigignore file
Rodrigo Alves Vieira authored
16
17 ## Authors
18
19 Marcel Caraciolo (marcel@muricoca.com)
20
21 Bruno Melo (bruno@muricoca.com)
22
23 Ricardo Caspirro (ricardo@muricoca.com)
24
25 Rodrigo Alves (rodrigo@muricoca.com)
26
27 ## Bugs, Feedback
28
29 Please submit bugs you might encounter, as well Patches and Features Requests to the [Issues Tracker](https://github.com/muricoca/crab/issues) located at GitHub.
30
31 ## Contributions
32
33 If you want to submit a patch to this project, it is AWESOME. Follow this guide:
34
35 * Fork Crab
36 * Make your alterations and commit
37 * Create a topic branch - git checkout -b my_branch
38 * Push to your branch - git push origin my_branch
39 * Create a [Pull Request](http://help.github.com/pull-requests/) from your branch.
40 * You just contributed to the Crab project!
41
42 ## Wiki
43
117f1d2 Fixed the broken link to the Crab Wiki
Rodrigo Alves Vieira authored
44 Please check our [Wiki](https://github.com/muricoca/crab/wiki "Crab Wiki") wiki, for further information on how to start developing or use Crab in your projects.
1ea7ef7 Improving README and adding .gigignore file
Rodrigo Alves Vieira authored
45
b028295 Adding the BSD acronym to the README
Rodrigo Alves Vieira authored
46 ## LICENCE (BSD)
1ea7ef7 Improving README and adding .gigignore file
Rodrigo Alves Vieira authored
47
48 Copyright (c) 2011, Muriçoca Labs
65851d7 Little README fix
Rodrigo Alves Vieira authored
49
1ea7ef7 Improving README and adding .gigignore file
Rodrigo Alves Vieira authored
50 All rights reserved.
51
52 Redistribution and use in source and binary forms, with or without
53 modification, are permitted provided that the following conditions are met:
54 * Redistributions of source code must retain the above copyright
55 notice, this list of conditions and the following disclaimer.
56 * Redistributions in binary form must reproduce the above copyright
57 notice, this list of conditions and the following disclaimer in the
58 documentation and/or other materials provided with the distribution.
59 * Neither the name of the Muriçoca Labs nor the
60 names of its contributors may be used to endorse or promote products
61 derived from this software without specific prior written permission.
62
63 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
64 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
65 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
66 DISCLAIMED. IN NO EVENT SHALL MURIÇOCA LABS BE LIABLE FOR ANY
67 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
68 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
69 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
70 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
71 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
72 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
73
Something went wrong with that request. Please try again.