Skip to content

Commit

Permalink
Change a readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
filipebraida committed Nov 21, 2017
1 parent 00283da commit 90b782d
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion README.md
Expand Up @@ -4,6 +4,28 @@
[![Coverage Status](https://coveralls.io/repos/JuliaRecsys/DatasetsCF.jl/badge.svg?branch=master&service=github)](https://coveralls.io/github/JuliaRecsys/DatasetsCF.jl?branch=master)
[![codecov.io](http://codecov.io/github/JuliaRecsys/DatasetsCF.jl/coverage.svg?branch=master)](http://codecov.io/github/JuliaRecsys/DatasetsCF.jl?branch=master)

**Installation**: at the Julia REPL, `Pkg.clone("https://github.com/JuliaRecsys/DatasetsCF.jl.git")`
**Installation**: at the Julia REPL, `Pkg.add("DatasetsCF")`

**Reporting Issues and Contributing**: See [CONTRIBUTING.md](CONTRIBUTING.md)

## Example

```
julia> using DatasetsCF
julia> dataset = DatasetsCF.MovieLens();
julia> using Persa
julia> μ = Persa.mean(dataset)
3.52986
```

## Datasets

List of package datasets:

Dataset | Title
-------------|------------------------------------------------------------------------
MovieLens 100k | This is a set of 100,000 ratings given by a set of users to a set of movies.
MovieLens 1M | This is a set of 10,000,000 ratings given by a set of users to a set of movies.

0 comments on commit 90b782d

Please sign in to comment.