{"action":"created","comment":{"url":"https://api.github.com/repos/eHarmony/spotz/pulls/comments/77267124","id":77267124,"diff_hunk":"@@ -1,2 +1,189 @@\n # spotz [![Build Status](https://travis-ci.org/eHarmony/spotz.svg?branch=master)](https://travis-ci.org/eHarmony/spotz) [![Stories in Ready](https://badge.waffle.io/eHarmony/spotz.png?label=ready&title=Ready)](https://waffle.io/eHarmony/spotz) #\n-Spark Parameter Optimization\n+# Spark Parameter Optimization\n+\n+Spotz is a\n+[hyperparameter optimization](https://en.wikipedia.org/wiki/Hyperparameter_optimization)\n+framework written in [Scala](http://www.scala-lang.org) designed to exploit\n+[Apache Spark](http://spark.apache.org) perform its distributed computation.\n+A broad set of optimization algorithms have been implemented to solve for the\n+hyperparameter values of an [objective function](https://en.wikipedia.org/wiki/Loss_function)\n+that you specify.\n+\n+## Motivation\n+The [eHarmony](http://www.eharmony.com) modeling team primarily uses Spark\n+and Scala as the base of its machine learning pipeline.  Given that Spark\n+is our distributed compute engine of choice, we have need for a robust\n+hyperparameter optimization framework that integrates well with Spark.  There\n+are already excellent frameworks out there like\n+[Hyperopt](http://hyperopt.github.io/hyperopt) and\n+[Optunity](http://optunity.readthedocs.io/en/latest),\n+written in Python, but the ideal framework that runs in Scala on top of Spark\n+does not exist.  [MLlib](http://spark.apache.org/mllib), though providing\n+some support for Grid Search, is not a general framework for hyperparameter\n+tuning and does not integrate with other learners.  This project's purpose is\n+to build a simple framework that developers can integrate with Spark to fulfill\n+their hyperparameter optimization needs.\n+\n+## VowpalWabbit\n+At [eHarmony](http://www.eharmony.com), we make heavy use of\n+[VowpalWabbit](https://github.com/JohnLangford/vowpal_wabbit/wiki).\n+We use this learner so much that we feel strong integration with VW is very\n+important.  Considering that VowpalWabbit does not support hyperparameter\n+optimization out of the box, we've taken steps to support it without losing\n+generality.\n+\n+## Optimization Algorithms\n+\n+Currently the following solvers have been implemented:\n+\n+* [Random Search](https://en.wikipedia.org/wiki/Random_search)\n+* [Grid Search](https://en.wikipedia.org/wiki/Grid_search_method)\n+* We are currently exploring other search algorithms to add\n+\n+## Maven dependency\n+\n+To use this as part of a maven build\n+\n+```xml\n+<dependency>\n+    <groupId>com.eharmony</groupId>\n+    <artifactId>spotz-core</artifactId>\n+    <version>1.0.0</version>\n+<dependency>\n+```\n+\n+## Usage\n+\n+Using this framework consists of writing the following boilerplate code:\n+\n+1. Import the default definitions from the spotz ```Preamble``` object.\n+Importing from a library Preamble is a Scala convention to bring in default\n+definitions into the current scope.\n+2. Define the objective function.\n+3. Define the space of hyperparameter values that you wish to search.\n+4. Select the solver.\n+\n+## Imports\n+\n+Import the default definitions from the spotz preamble object\n+\n+```scala\n+import com.eharmony.spotz.Preamble._\n+```\n+\n+## Objective Function Trait\n+\n+Define your objective function by implementing the ```Objective[P, L]```\n+trait.\n+\n+```scala\n+import com.eharmony.spotz.objective.Objective\n+\n+trait Objective[P, L]  {\n+  def apply(point: P): L\n+}\n+```\n+\n+Note that the objective function trait is type parameterized ```[P, L]``` for\n+the point and the loss.  This function must simply implement the\n+```apply(point: P): L``` method of that trait.  The point type parameter is an\n+abstract representation of the current hyperparameter values and is passed\n+into the trait through the apply method.  The loss is the value returned from\n+evaluating the objective function on that point.  The framework default\n+implementation provides a ```Point``` class for the ```P``` type parameter \n+within the ```Preamble``` object and uses ```Double``` as the loss value.\n+Again, importing the default definitions within the Preamble object\n+is important for this to work.\n+\n+The Branin-Hoo function is shown here as a simple example.","path":"README.md","position":99,"original_position":99,"commit_id":"4559ab1e0bb5e778462aa965fc506d00dfa2b73d","original_commit_id":"4559ab1e0bb5e778462aa965fc506d00dfa2b73d","user":{"login":"jmorra","id":117275,"avatar_url":"https://avatars.githubusercontent.com/u/117275?v=3","gravatar_id":"","url":"https://api.github.com/users/jmorra","html_url":"https://github.com/jmorra","followers_url":"https://api.github.com/users/jmorra/followers","following_url":"https://api.github.com/users/jmorra/following{/other_user}","gists_url":"https://api.github.com/users/jmorra/gists{/gist_id}","starred_url":"https://api.github.com/users/jmorra/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jmorra/subscriptions","organizations_url":"https://api.github.com/users/jmorra/orgs","repos_url":"https://api.github.com/users/jmorra/repos","events_url":"https://api.github.com/users/jmorra/events{/privacy}","received_events_url":"https://api.github.com/users/jmorra/received_events","type":"User","site_admin":false},"body":"I would stick the link around Branin-Hoo.","created_at":"2016-09-01T22:41:40Z","updated_at":"2016-09-01T22:41:40Z","html_url":"https://github.com/eHarmony/spotz/pull/30#discussion_r77267124","pull_request_url":"https://api.github.com/repos/eHarmony/spotz/pulls/30","_links":{"self":{"href":"https://api.github.com/repos/eHarmony/spotz/pulls/comments/77267124"},"html":{"href":"https://github.com/eHarmony/spotz/pull/30#discussion_r77267124"},"pull_request":{"href":"https://api.github.com/repos/eHarmony/spotz/pulls/30"}}},"pull_request":{"url":"https://api.github.com/repos/eHarmony/spotz/pulls/30","id":83705528,"html_url":"https://github.com/eHarmony/spotz/pull/30","diff_url":"https://github.com/eHarmony/spotz/pull/30.diff","patch_url":"https://github.com/eHarmony/spotz/pull/30.patch","issue_url":"https://api.github.com/repos/eHarmony/spotz/issues/30","number":30,"state":"open","locked":false,"title":"Branch 1.0.0","user":{"login":"vsuthichai","id":2184688,"avatar_url":"https://avatars.githubusercontent.com/u/2184688?v=3","gravatar_id":"","url":"https://api.github.com/users/vsuthichai","html_url":"https://github.com/vsuthichai","followers_url":"https://api.github.com/users/vsuthichai/followers","following_url":"https://api.github.com/users/vsuthichai/following{/other_user}","gists_url":"https://api.github.com/users/vsuthichai/gists{/gist_id}","starred_url":"https://api.github.com/users/vsuthichai/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/vsuthichai/subscriptions","organizations_url":"https://api.github.com/users/vsuthichai/orgs","repos_url":"https://api.github.com/users/vsuthichai/repos","events_url":"https://api.github.com/users/vsuthichai/events{/privacy}","received_events_url":"https://api.github.com/users/vsuthichai/received_events","type":"User","site_admin":false},"body":"\n\n<!-- Reviewable:start -->\nThis change is [<img src=\"https://reviewable.io/review_button.svg\" height=\"34\" align=\"absmiddle\" alt=\"Reviewable\"/>](https://reviewable.io/reviews/eharmony/spotz/30)\n<!-- Reviewable:end -->\n","created_at":"2016-09-01T20:57:02Z","updated_at":"2016-09-01T22:41:40Z","closed_at":null,"merged_at":null,"merge_commit_sha":"4027d00005a294a8eb35b328f24b3bd8e76d3249","assignee":null,"assignees":[],"milestone":null,"commits_url":"https://api.github.com/repos/eHarmony/spotz/pulls/30/commits","review_comments_url":"https://api.github.com/repos/eHarmony/spotz/pulls/30/comments","review_comment_url":"https://api.github.com/repos/eHarmony/spotz/pulls/comments{/number}","comments_url":"https://api.github.com/repos/eHarmony/spotz/issues/30/comments","statuses_url":"https://api.github.com/repos/eHarmony/spotz/statuses/4559ab1e0bb5e778462aa965fc506d00dfa2b73d","head":{"label":"eHarmony:branch-1.0.0","ref":"branch-1.0.0","sha":"4559ab1e0bb5e778462aa965fc506d00dfa2b73d","user":{"login":"eHarmony","id":1245717,"avatar_url":"https://avatars.githubusercontent.com/u/1245717?v=3","gravatar_id":"","url":"https://api.github.com/users/eHarmony","html_url":"https://github.com/eHarmony","followers_url":"https://api.github.com/users/eHarmony/followers","following_url":"https://api.github.com/users/eHarmony/following{/other_user}","gists_url":"https://api.github.com/users/eHarmony/gists{/gist_id}","starred_url":"https://api.github.com/users/eHarmony/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/eHarmony/subscriptions","organizations_url":"https://api.github.com/users/eHarmony/orgs","repos_url":"https://api.github.com/users/eHarmony/repos","events_url":"https://api.github.com/users/eHarmony/events{/privacy}","received_events_url":"https://api.github.com/users/eHarmony/received_events","type":"Organization","site_admin":false},"repo":{"id":53437479,"name":"spotz","full_name":"eHarmony/spotz","owner":{"login":"eHarmony","id":1245717,"avatar_url":"https://avatars.githubusercontent.com/u/1245717?v=3","gravatar_id":"","url":"https://api.github.com/users/eHarmony","html_url":"https://github.com/eHarmony","followers_url":"https://api.github.com/users/eHarmony/followers","following_url":"https://api.github.com/users/eHarmony/following{/other_user}","gists_url":"https://api.github.com/users/eHarmony/gists{/gist_id}","starred_url":"https://api.github.com/users/eHarmony/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/eHarmony/subscriptions","organizations_url":"https://api.github.com/users/eHarmony/orgs","repos_url":"https://api.github.com/users/eHarmony/repos","events_url":"https://api.github.com/users/eHarmony/events{/privacy}","received_events_url":"https://api.github.com/users/eHarmony/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/eHarmony/spotz","description":"Spark Parameter Optimization and Tuning","fork":false,"url":"https://api.github.com/repos/eHarmony/spotz","forks_url":"https://api.github.com/repos/eHarmony/spotz/forks","keys_url":"https://api.github.com/repos/eHarmony/spotz/keys{/key_id}","collaborators_url":"https://api.github.com/repos/eHarmony/spotz/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/eHarmony/spotz/teams","hooks_url":"https://api.github.com/repos/eHarmony/spotz/hooks","issue_events_url":"https://api.github.com/repos/eHarmony/spotz/issues/events{/number}","events_url":"https://api.github.com/repos/eHarmony/spotz/events","assignees_url":"https://api.github.com/repos/eHarmony/spotz/assignees{/user}","branches_url":"https://api.github.com/repos/eHarmony/spotz/branches{/branch}","tags_url":"https://api.github.com/repos/eHarmony/spotz/tags","blobs_url":"https://api.github.com/repos/eHarmony/spotz/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/eHarmony/spotz/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/eHarmony/spotz/git/refs{/sha}","trees_url":"https://api.github.com/repos/eHarmony/spotz/git/trees{/sha}","statuses_url":"https://api.github.com/repos/eHarmony/spotz/statuses/{sha}","languages_url":"https://api.github.com/repos/eHarmony/spotz/languages","stargazers_url":"https://api.github.com/repos/eHarmony/spotz/stargazers","contributors_url":"https://api.github.com/repos/eHarmony/spotz/contributors","subscribers_url":"https://api.github.com/repos/eHarmony/spotz/subscribers","subscription_url":"https://api.github.com/repos/eHarmony/spotz/subscription","commits_url":"https://api.github.com/repos/eHarmony/spotz/commits{/sha}","git_commits_url":"https://api.github.com/repos/eHarmony/spotz/git/commits{/sha}","comments_url":"https://api.github.com/repos/eHarmony/spotz/comments{/number}","issue_comment_url":"https://api.github.com/repos/eHarmony/spotz/issues/comments{/number}","contents_url":"https://api.github.com/repos/eHarmony/spotz/contents/{+path}","compare_url":"https://api.github.com/repos/eHarmony/spotz/compare/{base}...{head}","merges_url":"https://api.github.com/repos/eHarmony/spotz/merges","archive_url":"https://api.github.com/repos/eHarmony/spotz/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/eHarmony/spotz/downloads","issues_url":"https://api.github.com/repos/eHarmony/spotz/issues{/number}","pulls_url":"https://api.github.com/repos/eHarmony/spotz/pulls{/number}","milestones_url":"https://api.github.com/repos/eHarmony/spotz/milestones{/number}","notifications_url":"https://api.github.com/repos/eHarmony/spotz/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/eHarmony/spotz/labels{/name}","releases_url":"https://api.github.com/repos/eHarmony/spotz/releases{/id}","deployments_url":"https://api.github.com/repos/eHarmony/spotz/deployments","created_at":"2016-03-08T19:02:26Z","updated_at":"2016-08-05T15:16:22Z","pushed_at":"2016-09-01T20:57:06Z","git_url":"git://github.com/eHarmony/spotz.git","ssh_url":"git@github.com:eHarmony/spotz.git","clone_url":"https://github.com/eHarmony/spotz.git","svn_url":"https://github.com/eHarmony/spotz","homepage":"","size":209,"stargazers_count":2,"watchers_count":2,"language":"Scala","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":16,"forks":0,"open_issues":16,"watchers":2,"default_branch":"master"}},"base":{"label":"eHarmony:master","ref":"master","sha":"07a31949104f03db0830c15a52edf3ab9b33f2ce","user":{"login":"eHarmony","id":1245717,"avatar_url":"https://avatars.githubusercontent.com/u/1245717?v=3","gravatar_id":"","url":"https://api.github.com/users/eHarmony","html_url":"https://github.com/eHarmony","followers_url":"https://api.github.com/users/eHarmony/followers","following_url":"https://api.github.com/users/eHarmony/following{/other_user}","gists_url":"https://api.github.com/users/eHarmony/gists{/gist_id}","starred_url":"https://api.github.com/users/eHarmony/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/eHarmony/subscriptions","organizations_url":"https://api.github.com/users/eHarmony/orgs","repos_url":"https://api.github.com/users/eHarmony/repos","events_url":"https://api.github.com/users/eHarmony/events{/privacy}","received_events_url":"https://api.github.com/users/eHarmony/received_events","type":"Organization","site_admin":false},"repo":{"id":53437479,"name":"spotz","full_name":"eHarmony/spotz","owner":{"login":"eHarmony","id":1245717,"avatar_url":"https://avatars.githubusercontent.com/u/1245717?v=3","gravatar_id":"","url":"https://api.github.com/users/eHarmony","html_url":"https://github.com/eHarmony","followers_url":"https://api.github.com/users/eHarmony/followers","following_url":"https://api.github.com/users/eHarmony/following{/other_user}","gists_url":"https://api.github.com/users/eHarmony/gists{/gist_id}","starred_url":"https://api.github.com/users/eHarmony/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/eHarmony/subscriptions","organizations_url":"https://api.github.com/users/eHarmony/orgs","repos_url":"https://api.github.com/users/eHarmony/repos","events_url":"https://api.github.com/users/eHarmony/events{/privacy}","received_events_url":"https://api.github.com/users/eHarmony/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/eHarmony/spotz","description":"Spark Parameter Optimization and Tuning","fork":false,"url":"https://api.github.com/repos/eHarmony/spotz","forks_url":"https://api.github.com/repos/eHarmony/spotz/forks","keys_url":"https://api.github.com/repos/eHarmony/spotz/keys{/key_id}","collaborators_url":"https://api.github.com/repos/eHarmony/spotz/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/eHarmony/spotz/teams","hooks_url":"https://api.github.com/repos/eHarmony/spotz/hooks","issue_events_url":"https://api.github.com/repos/eHarmony/spotz/issues/events{/number}","events_url":"https://api.github.com/repos/eHarmony/spotz/events","assignees_url":"https://api.github.com/repos/eHarmony/spotz/assignees{/user}","branches_url":"https://api.github.com/repos/eHarmony/spotz/branches{/branch}","tags_url":"https://api.github.com/repos/eHarmony/spotz/tags","blobs_url":"https://api.github.com/repos/eHarmony/spotz/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/eHarmony/spotz/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/eHarmony/spotz/git/refs{/sha}","trees_url":"https://api.github.com/repos/eHarmony/spotz/git/trees{/sha}","statuses_url":"https://api.github.com/repos/eHarmony/spotz/statuses/{sha}","languages_url":"https://api.github.com/repos/eHarmony/spotz/languages","stargazers_url":"https://api.github.com/repos/eHarmony/spotz/stargazers","contributors_url":"https://api.github.com/repos/eHarmony/spotz/contributors","subscribers_url":"https://api.github.com/repos/eHarmony/spotz/subscribers","subscription_url":"https://api.github.com/repos/eHarmony/spotz/subscription","commits_url":"https://api.github.com/repos/eHarmony/spotz/commits{/sha}","git_commits_url":"https://api.github.com/repos/eHarmony/spotz/git/commits{/sha}","comments_url":"https://api.github.com/repos/eHarmony/spotz/comments{/number}","issue_comment_url":"https://api.github.com/repos/eHarmony/spotz/issues/comments{/number}","contents_url":"https://api.github.com/repos/eHarmony/spotz/contents/{+path}","compare_url":"https://api.github.com/repos/eHarmony/spotz/compare/{base}...{head}","merges_url":"https://api.github.com/repos/eHarmony/spotz/merges","archive_url":"https://api.github.com/repos/eHarmony/spotz/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/eHarmony/spotz/downloads","issues_url":"https://api.github.com/repos/eHarmony/spotz/issues{/number}","pulls_url":"https://api.github.com/repos/eHarmony/spotz/pulls{/number}","milestones_url":"https://api.github.com/repos/eHarmony/spotz/milestones{/number}","notifications_url":"https://api.github.com/repos/eHarmony/spotz/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/eHarmony/spotz/labels{/name}","releases_url":"https://api.github.com/repos/eHarmony/spotz/releases{/id}","deployments_url":"https://api.github.com/repos/eHarmony/spotz/deployments","created_at":"2016-03-08T19:02:26Z","updated_at":"2016-08-05T15:16:22Z","pushed_at":"2016-09-01T20:57:06Z","git_url":"git://github.com/eHarmony/spotz.git","ssh_url":"git@github.com:eHarmony/spotz.git","clone_url":"https://github.com/eHarmony/spotz.git","svn_url":"https://github.com/eHarmony/spotz","homepage":"","size":209,"stargazers_count":2,"watchers_count":2,"language":"Scala","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":16,"forks":0,"open_issues":16,"watchers":2,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/eHarmony/spotz/pulls/30"},"html":{"href":"https://github.com/eHarmony/spotz/pull/30"},"issue":{"href":"https://api.github.com/repos/eHarmony/spotz/issues/30"},"comments":{"href":"https://api.github.com/repos/eHarmony/spotz/issues/30/comments"},"review_comments":{"href":"https://api.github.com/repos/eHarmony/spotz/pulls/30/comments"},"review_comment":{"href":"https://api.github.com/repos/eHarmony/spotz/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/eHarmony/spotz/pulls/30/commits"},"statuses":{"href":"https://api.github.com/repos/eHarmony/spotz/statuses/4559ab1e0bb5e778462aa965fc506d00dfa2b73d"}}}}
{"actor":{"display_login":"jmorra"}}