Skip to content

Commit

Permalink
updated README.md and pom.xml
Browse files Browse the repository at this point in the history
  • Loading branch information
ccolburn committed Feb 19, 2015
1 parent 68740be commit 9d403dd
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 7 deletions.
29 changes: 25 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,32 @@

A collection of tools for analysis in Pig and Hive.

# Description
## Description

Over the next year we plan to release a handful of our internal user defined functions (UDF’s) that have broad adoption across Netflix. The use cases for these functions are varied in nature (e.g. scoring predictive models, outlier detection, pattern matching, etc.) and together extend the analytical capabilities of big data.

# Functions
Over the next year we plan to release a handful of our internal user defined functions (UDFs) that have broad adoption across Netflix. The use
cases for these functions are varied in nature (e.g. scoring predictive models, outlier detection, pattern matching, etc.) and together extend
the analytical capabilities of big data.

## Functions
* ScorePMML - A tool for scoring predictive models in the cloud.
* Robust Anomaly Detection (RAD) - An implementation of the Robust PCA.

## Building Surus

Surus is a standard Maven project. After cloning the git repository you can simply run the following command from the project root directory:

mvn clean package

On the first build, Maven will download all the dependencies from the internet and cache them in the local repository (`~/.m2/repository`), which
can take a considerable amount of time. Subsequent builds will be faster.

## Using Surus

After building Surus you will need to move it to your Hive/Pig instance and register the JAR in your environment. For those
unfamiliar with this process see the [Apache Pig UDF](https://pig.apache.org/docs/r0.14.0/udf.html),
and [Hive Plugin](https://cwiki.apache.org/confluence/display/Hive/HivePlugins), documentation.

You can also install the anomaly detection R package trivially with this code

library(devtools)
install_github(repo = "Surus", username = "Netflix", subdir = "resources/R/RAD")
6 changes: 3 additions & 3 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@
<modelVersion>4.0.0</modelVersion>

<groupId>netflix</groupId>
<artifactId>scoring</artifactId>
<version>0.1.2</version>
<artifactId>surus</artifactId>
<version>0.1.4</version>
<packaging>jar</packaging>

<name>scoring</name>
<name>surus</name>
<url>http://maven.apache.org</url>

<properties>
Expand Down

0 comments on commit 9d403dd

Please sign in to comment.