{"action":"created","comment":{"url":"https://api.github.com/repos/stanford-futuredata/macrobase/pulls/comments/53560725","id":53560725,"diff_hunk":"@@ -0,0 +1,189 @@\n+This document attempts to describe the important parameters in Macrobase that\n+affect its behavior.\n+\n+We first describe workload-specific parameters, that _need_ to be specified for\n+every workload. These parameters do not have default values, so Macrobase will\n+throw an exception if these aren't specified.\n+\n+<table class=\"table\">\n+<tr><th>Name</th><th>Default</th><th>Meaning</th></tr>\n+<tr>\n+  <td><code>macrobase.query.name</code></td>\n+  <td>(none)</td>\n+  <td>\n+  Human-readable task name, used to identify the workload.\n+  </td>\n+</tr>\n+<tr>\n+  <td><code>macrobase.loader.attributes</code></td>\n+  <td>(none)</td>\n+  <td>\n+  List of attributes to group by. These\n+must be categorical.\n+  </td>\n+</tr>\n+  <td><code>macrobase.loader.targetLowMetrics</code></td>\n+  <td>(none)</td>\n+  <td>\n+  List of metrics to detect outliers from.\n+These metrics have <i>low</i> values, and so are labeled as low so that Macrobase's\n+outlier detection algorithms can gain more separation by looking at their\n+reciprocals. Must be a floating point number.\n+  </td>\n+</tr>\n+<tr>\n+  <td><code>macrobase.loader.targetHighMetrics</code></td>\n+  <td>(none)</td>\n+  <td>\n+  List of metrics to detect outliers from (along with <code>targetLowMetrics</code>. These\n+metrics have <i>high</i> values, and can be easily separated as is. Must be a floating\n+point number.\n+  </td>\n+</tr>\n+<tr>\n+  <td><code>macrobase.loader.baseQuery</code></td>\n+  <td>(none)</td>\n+  <td>\n+  /Query used to specify input data source. Can be used to restrict\n+the rows or columns Macrobase needs to look at.\n+  </td>\n+</tr>\n+</table>\n+\n+The following are generic parameters, used in both our streaming and batching\n+workloads.\n+\n+<table class=\"table\">\n+<tr><th>Name</th><th>Default</th><th>Meaning</th></tr>\n+<tr>\n+  <td><code>macrobase.analysis.minSupport</code></td>\n+  <td><code>0.001</code></td>\n+  <td>\n+  Only attributes (or groups of attributes) that have\n+relative count greater than this value are returned.\n+  </td>\n+</tr>\n+<tr>\n+  <td><code>macrobase.analysis.minOIRatio</code></td>\n+  <td><code>3.0</code></td>\n+  <td>\n+  Only attributes (or groups of attributes) that occur\n+in the outliers <code>minInlierRatio</code> more times than in the inliers are returned.\n+  </td>\n+</tr>\n+  <td><code>macrobase.analysis.zScore</code> and <code>macrobase.analysis.useZScore</code></td>\n+  <td><code>3.0</code> and <code>false</code></td>\n+  <td>\n+  Specifies zScore threshold to distinguish the\n+outliers from the inliers. The zScore is as defined by the detection mechanism's\n+<code>getZScoreEquivalent</code> method.\n+  </td>\n+</tr>\n+<tr>\n+  <td><code>macrobase.analysis.targetPercentile</code> and <code>macrobase.analysis.usePercentile</code></td>\n+  <td><code>0.99</code> and <code>true</code></td>\n+  <td>\n+  Specifies percentile threshold to\n+distinguish the outliers from the inliers. If <code>targetPercentile</code> is set to 99%,\n+then all points with scores greater than the score of the 99%th point are flagged\n+as outliers.\n+  </td>\n+</tr>\n+<tr>\n+  <td><code>macrobase.analysis.mcd.alpha</code></td>\n+  <td><code>0.5</code></td>\n+  <td>\n+  This is a <b>MCD-only</b> parameter. Controls the size of\n+the cloud of points sampled from the entire dataset of points. In the first\n+example described\n+<a href=\"https://tr8dr.wordpress.com/2010/09/24/minimum-covariance-determination/\">here</a>\n+, <code>alphaMCD = 0.9</code>, for example.\n+  </td>\n+</tr>\n+<tr>\n+  <td><code>macrobase.analysis.mcd.stroppingDelta</code></td>\n+  <td><code>0.001</code></td>\n+  <td>\n+  This is again a <b>MCD-only</b> parameter. Controls\n+the stopping condition in the training phase of MCD.","path":"docs/parameters_desc.md","position":108,"original_position":108,"commit_id":"afbd410a96841b0dcdce8b4fb72d553f2f0983d3","original_commit_id":"afbd410a96841b0dcdce8b4fb72d553f2f0983d3","user":{"login":"pbailis","id":970191,"avatar_url":"https://avatars.githubusercontent.com/u/970191?v=3","gravatar_id":"","url":"https://api.github.com/users/pbailis","html_url":"https://github.com/pbailis","followers_url":"https://api.github.com/users/pbailis/followers","following_url":"https://api.github.com/users/pbailis/following{/other_user}","gists_url":"https://api.github.com/users/pbailis/gists{/gist_id}","starred_url":"https://api.github.com/users/pbailis/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/pbailis/subscriptions","organizations_url":"https://api.github.com/users/pbailis/orgs","repos_url":"https://api.github.com/users/pbailis/repos","events_url":"https://api.github.com/users/pbailis/events{/privacy}","received_events_url":"https://api.github.com/users/pbailis/received_events","type":"User","site_admin":false},"body":"In the \"c-step\" of FastMCD.","created_at":"2016-02-21T02:41:03Z","updated_at":"2016-02-21T02:41:03Z","html_url":"https://github.com/stanford-futuredata/macrobase/pull/80#discussion_r53560725","pull_request_url":"https://api.github.com/repos/stanford-futuredata/macrobase/pulls/80","_links":{"self":{"href":"https://api.github.com/repos/stanford-futuredata/macrobase/pulls/comments/53560725"},"html":{"href":"https://github.com/stanford-futuredata/macrobase/pull/80#discussion_r53560725"},"pull_request":{"href":"https://api.github.com/repos/stanford-futuredata/macrobase/pulls/80"}}},"pull_request":{"url":"https://api.github.com/repos/stanford-futuredata/macrobase/pulls/80","id":60040636,"html_url":"https://github.com/stanford-futuredata/macrobase/pull/80","diff_url":"https://github.com/stanford-futuredata/macrobase/pull/80.diff","patch_url":"https://github.com/stanford-futuredata/macrobase/pull/80.patch","issue_url":"https://api.github.com/repos/stanford-futuredata/macrobase/issues/80","number":80,"state":"open","locked":false,"title":"Parameters description: parameter names, parameter descriptions and d…","user":{"login":"deepakn94","id":2724038,"avatar_url":"https://avatars.githubusercontent.com/u/2724038?v=3","gravatar_id":"","url":"https://api.github.com/users/deepakn94","html_url":"https://github.com/deepakn94","followers_url":"https://api.github.com/users/deepakn94/followers","following_url":"https://api.github.com/users/deepakn94/following{/other_user}","gists_url":"https://api.github.com/users/deepakn94/gists{/gist_id}","starred_url":"https://api.github.com/users/deepakn94/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/deepakn94/subscriptions","organizations_url":"https://api.github.com/users/deepakn94/orgs","repos_url":"https://api.github.com/users/deepakn94/repos","events_url":"https://api.github.com/users/deepakn94/events{/privacy}","received_events_url":"https://api.github.com/users/deepakn94/received_events","type":"User","site_admin":false},"body":"…efault\r\n\r\nvalues are now in the table in parameters_desc.md\r\n\r\n@pbailis ","created_at":"2016-02-20T07:11:05Z","updated_at":"2016-02-21T02:41:03Z","closed_at":null,"merged_at":null,"merge_commit_sha":"20eeeccb7cbfcb17bbcb704ef55ec9a5f37b9fc2","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/stanford-futuredata/macrobase/pulls/80/commits","review_comments_url":"https://api.github.com/repos/stanford-futuredata/macrobase/pulls/80/comments","review_comment_url":"https://api.github.com/repos/stanford-futuredata/macrobase/pulls/comments{/number}","comments_url":"https://api.github.com/repos/stanford-futuredata/macrobase/issues/80/comments","statuses_url":"https://api.github.com/repos/stanford-futuredata/macrobase/statuses/afbd410a96841b0dcdce8b4fb72d553f2f0983d3","head":{"label":"stanford-futuredata:docs","ref":"docs","sha":"afbd410a96841b0dcdce8b4fb72d553f2f0983d3","user":{"login":"stanford-futuredata","id":16332752,"avatar_url":"https://avatars.githubusercontent.com/u/16332752?v=3","gravatar_id":"","url":"https://api.github.com/users/stanford-futuredata","html_url":"https://github.com/stanford-futuredata","followers_url":"https://api.github.com/users/stanford-futuredata/followers","following_url":"https://api.github.com/users/stanford-futuredata/following{/other_user}","gists_url":"https://api.github.com/users/stanford-futuredata/gists{/gist_id}","starred_url":"https://api.github.com/users/stanford-futuredata/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/stanford-futuredata/subscriptions","organizations_url":"https://api.github.com/users/stanford-futuredata/orgs","repos_url":"https://api.github.com/users/stanford-futuredata/repos","events_url":"https://api.github.com/users/stanford-futuredata/events{/privacy}","received_events_url":"https://api.github.com/users/stanford-futuredata/received_events","type":"Organization","site_admin":false},"repo":{"id":48199522,"name":"macrobase","full_name":"stanford-futuredata/macrobase","owner":{"login":"stanford-futuredata","id":16332752,"avatar_url":"https://avatars.githubusercontent.com/u/16332752?v=3","gravatar_id":"","url":"https://api.github.com/users/stanford-futuredata","html_url":"https://github.com/stanford-futuredata","followers_url":"https://api.github.com/users/stanford-futuredata/followers","following_url":"https://api.github.com/users/stanford-futuredata/following{/other_user}","gists_url":"https://api.github.com/users/stanford-futuredata/gists{/gist_id}","starred_url":"https://api.github.com/users/stanford-futuredata/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/stanford-futuredata/subscriptions","organizations_url":"https://api.github.com/users/stanford-futuredata/orgs","repos_url":"https://api.github.com/users/stanford-futuredata/repos","events_url":"https://api.github.com/users/stanford-futuredata/events{/privacy}","received_events_url":"https://api.github.com/users/stanford-futuredata/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/stanford-futuredata/macrobase","description":"http://macrobase.io/","fork":false,"url":"https://api.github.com/repos/stanford-futuredata/macrobase","forks_url":"https://api.github.com/repos/stanford-futuredata/macrobase/forks","keys_url":"https://api.github.com/repos/stanford-futuredata/macrobase/keys{/key_id}","collaborators_url":"https://api.github.com/repos/stanford-futuredata/macrobase/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/stanford-futuredata/macrobase/teams","hooks_url":"https://api.github.com/repos/stanford-futuredata/macrobase/hooks","issue_events_url":"https://api.github.com/repos/stanford-futuredata/macrobase/issues/events{/number}","events_url":"https://api.github.com/repos/stanford-futuredata/macrobase/events","assignees_url":"https://api.github.com/repos/stanford-futuredata/macrobase/assignees{/user}","branches_url":"https://api.github.com/repos/stanford-futuredata/macrobase/branches{/branch}","tags_url":"https://api.github.com/repos/stanford-futuredata/macrobase/tags","blobs_url":"https://api.github.com/repos/stanford-futuredata/macrobase/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/stanford-futuredata/macrobase/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/stanford-futuredata/macrobase/git/refs{/sha}","trees_url":"https://api.github.com/repos/stanford-futuredata/macrobase/git/trees{/sha}","statuses_url":"https://api.github.com/repos/stanford-futuredata/macrobase/statuses/{sha}","languages_url":"https://api.github.com/repos/stanford-futuredata/macrobase/languages","stargazers_url":"https://api.github.com/repos/stanford-futuredata/macrobase/stargazers","contributors_url":"https://api.github.com/repos/stanford-futuredata/macrobase/contributors","subscribers_url":"https://api.github.com/repos/stanford-futuredata/macrobase/subscribers","subscription_url":"https://api.github.com/repos/stanford-futuredata/macrobase/subscription","commits_url":"https://api.github.com/repos/stanford-futuredata/macrobase/commits{/sha}","git_commits_url":"https://api.github.com/repos/stanford-futuredata/macrobase/git/commits{/sha}","comments_url":"https://api.github.com/repos/stanford-futuredata/macrobase/comments{/number}","issue_comment_url":"https://api.github.com/repos/stanford-futuredata/macrobase/issues/comments{/number}","contents_url":"https://api.github.com/repos/stanford-futuredata/macrobase/contents/{+path}","compare_url":"https://api.github.com/repos/stanford-futuredata/macrobase/compare/{base}...{head}","merges_url":"https://api.github.com/repos/stanford-futuredata/macrobase/merges","archive_url":"https://api.github.com/repos/stanford-futuredata/macrobase/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/stanford-futuredata/macrobase/downloads","issues_url":"https://api.github.com/repos/stanford-futuredata/macrobase/issues{/number}","pulls_url":"https://api.github.com/repos/stanford-futuredata/macrobase/pulls{/number}","milestones_url":"https://api.github.com/repos/stanford-futuredata/macrobase/milestones{/number}","notifications_url":"https://api.github.com/repos/stanford-futuredata/macrobase/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/stanford-futuredata/macrobase/labels{/name}","releases_url":"https://api.github.com/repos/stanford-futuredata/macrobase/releases{/id}","deployments_url":"https://api.github.com/repos/stanford-futuredata/macrobase/deployments","created_at":"2015-12-17T21:36:20Z","updated_at":"2016-02-18T17:25:59Z","pushed_at":"2016-02-20T07:11:06Z","git_url":"git://github.com/stanford-futuredata/macrobase.git","ssh_url":"git@github.com:stanford-futuredata/macrobase.git","clone_url":"https://github.com/stanford-futuredata/macrobase.git","svn_url":"https://github.com/stanford-futuredata/macrobase","homepage":null,"size":921,"stargazers_count":7,"watchers_count":7,"language":"Java","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":2,"mirror_url":null,"open_issues_count":4,"forks":2,"open_issues":4,"watchers":7,"default_branch":"master"}},"base":{"label":"stanford-futuredata:master","ref":"master","sha":"8ee0307d9cccd726c4be4026cbfc7db7aee8d0a2","user":{"login":"stanford-futuredata","id":16332752,"avatar_url":"https://avatars.githubusercontent.com/u/16332752?v=3","gravatar_id":"","url":"https://api.github.com/users/stanford-futuredata","html_url":"https://github.com/stanford-futuredata","followers_url":"https://api.github.com/users/stanford-futuredata/followers","following_url":"https://api.github.com/users/stanford-futuredata/following{/other_user}","gists_url":"https://api.github.com/users/stanford-futuredata/gists{/gist_id}","starred_url":"https://api.github.com/users/stanford-futuredata/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/stanford-futuredata/subscriptions","organizations_url":"https://api.github.com/users/stanford-futuredata/orgs","repos_url":"https://api.github.com/users/stanford-futuredata/repos","events_url":"https://api.github.com/users/stanford-futuredata/events{/privacy}","received_events_url":"https://api.github.com/users/stanford-futuredata/received_events","type":"Organization","site_admin":false},"repo":{"id":48199522,"name":"macrobase","full_name":"stanford-futuredata/macrobase","owner":{"login":"stanford-futuredata","id":16332752,"avatar_url":"https://avatars.githubusercontent.com/u/16332752?v=3","gravatar_id":"","url":"https://api.github.com/users/stanford-futuredata","html_url":"https://github.com/stanford-futuredata","followers_url":"https://api.github.com/users/stanford-futuredata/followers","following_url":"https://api.github.com/users/stanford-futuredata/following{/other_user}","gists_url":"https://api.github.com/users/stanford-futuredata/gists{/gist_id}","starred_url":"https://api.github.com/users/stanford-futuredata/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/stanford-futuredata/subscriptions","organizations_url":"https://api.github.com/users/stanford-futuredata/orgs","repos_url":"https://api.github.com/users/stanford-futuredata/repos","events_url":"https://api.github.com/users/stanford-futuredata/events{/privacy}","received_events_url":"https://api.github.com/users/stanford-futuredata/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/stanford-futuredata/macrobase","description":"http://macrobase.io/","fork":false,"url":"https://api.github.com/repos/stanford-futuredata/macrobase","forks_url":"https://api.github.com/repos/stanford-futuredata/macrobase/forks","keys_url":"https://api.github.com/repos/stanford-futuredata/macrobase/keys{/key_id}","collaborators_url":"https://api.github.com/repos/stanford-futuredata/macrobase/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/stanford-futuredata/macrobase/teams","hooks_url":"https://api.github.com/repos/stanford-futuredata/macrobase/hooks","issue_events_url":"https://api.github.com/repos/stanford-futuredata/macrobase/issues/events{/number}","events_url":"https://api.github.com/repos/stanford-futuredata/macrobase/events","assignees_url":"https://api.github.com/repos/stanford-futuredata/macrobase/assignees{/user}","branches_url":"https://api.github.com/repos/stanford-futuredata/macrobase/branches{/branch}","tags_url":"https://api.github.com/repos/stanford-futuredata/macrobase/tags","blobs_url":"https://api.github.com/repos/stanford-futuredata/macrobase/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/stanford-futuredata/macrobase/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/stanford-futuredata/macrobase/git/refs{/sha}","trees_url":"https://api.github.com/repos/stanford-futuredata/macrobase/git/trees{/sha}","statuses_url":"https://api.github.com/repos/stanford-futuredata/macrobase/statuses/{sha}","languages_url":"https://api.github.com/repos/stanford-futuredata/macrobase/languages","stargazers_url":"https://api.github.com/repos/stanford-futuredata/macrobase/stargazers","contributors_url":"https://api.github.com/repos/stanford-futuredata/macrobase/contributors","subscribers_url":"https://api.github.com/repos/stanford-futuredata/macrobase/subscribers","subscription_url":"https://api.github.com/repos/stanford-futuredata/macrobase/subscription","commits_url":"https://api.github.com/repos/stanford-futuredata/macrobase/commits{/sha}","git_commits_url":"https://api.github.com/repos/stanford-futuredata/macrobase/git/commits{/sha}","comments_url":"https://api.github.com/repos/stanford-futuredata/macrobase/comments{/number}","issue_comment_url":"https://api.github.com/repos/stanford-futuredata/macrobase/issues/comments{/number}","contents_url":"https://api.github.com/repos/stanford-futuredata/macrobase/contents/{+path}","compare_url":"https://api.github.com/repos/stanford-futuredata/macrobase/compare/{base}...{head}","merges_url":"https://api.github.com/repos/stanford-futuredata/macrobase/merges","archive_url":"https://api.github.com/repos/stanford-futuredata/macrobase/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/stanford-futuredata/macrobase/downloads","issues_url":"https://api.github.com/repos/stanford-futuredata/macrobase/issues{/number}","pulls_url":"https://api.github.com/repos/stanford-futuredata/macrobase/pulls{/number}","milestones_url":"https://api.github.com/repos/stanford-futuredata/macrobase/milestones{/number}","notifications_url":"https://api.github.com/repos/stanford-futuredata/macrobase/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/stanford-futuredata/macrobase/labels{/name}","releases_url":"https://api.github.com/repos/stanford-futuredata/macrobase/releases{/id}","deployments_url":"https://api.github.com/repos/stanford-futuredata/macrobase/deployments","created_at":"2015-12-17T21:36:20Z","updated_at":"2016-02-18T17:25:59Z","pushed_at":"2016-02-20T07:11:06Z","git_url":"git://github.com/stanford-futuredata/macrobase.git","ssh_url":"git@github.com:stanford-futuredata/macrobase.git","clone_url":"https://github.com/stanford-futuredata/macrobase.git","svn_url":"https://github.com/stanford-futuredata/macrobase","homepage":null,"size":921,"stargazers_count":7,"watchers_count":7,"language":"Java","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":2,"mirror_url":null,"open_issues_count":4,"forks":2,"open_issues":4,"watchers":7,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/stanford-futuredata/macrobase/pulls/80"},"html":{"href":"https://github.com/stanford-futuredata/macrobase/pull/80"},"issue":{"href":"https://api.github.com/repos/stanford-futuredata/macrobase/issues/80"},"comments":{"href":"https://api.github.com/repos/stanford-futuredata/macrobase/issues/80/comments"},"review_comments":{"href":"https://api.github.com/repos/stanford-futuredata/macrobase/pulls/80/comments"},"review_comment":{"href":"https://api.github.com/repos/stanford-futuredata/macrobase/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/stanford-futuredata/macrobase/pulls/80/commits"},"statuses":{"href":"https://api.github.com/repos/stanford-futuredata/macrobase/statuses/afbd410a96841b0dcdce8b4fb72d553f2f0983d3"}}}}