{"action":"created","comment":{"url":"https://api.github.com/repos/dmlc/mxnet/pulls/comments/113569042","pull_request_review_id":34969139,"id":113569042,"diff_hunk":"@@ -37,27 +37,28 @@ struct SoftmaxOutputParam : public dmlc::Parameter<SoftmaxOutputParam> {\n   bool out_grad;\n   DMLC_DECLARE_PARAMETER(SoftmaxOutputParam) {\n     DMLC_DECLARE_FIELD(grad_scale).set_default(1.0f)\n-    .describe(\"Scale the gradient by a float factor\");\n+    .describe(\"Scale the gradient by a float factor.\");\n     DMLC_DECLARE_FIELD(ignore_label).set_default(-1.0f)\n-    .describe(\"the labels with value equals to ``ignore_label`` will be ignored \"\n-              \"during backward (only works if \"\n-              \"use_ignore is set to be true).\");\n+    .describe(\"The instances whose `labels` == `ignore_label` will be ignored \"\n+              \"during backward, if `use_ignore` is set to ``true``).\");\n     DMLC_DECLARE_FIELD(multi_output).set_default(false)\n-    .describe(\"If set to true, softmax will applied on axis 1\");\n+    .describe(\"If set to ``true``, the softmax function will be computed along \"\n+              \"the second axis.\");\n     DMLC_DECLARE_FIELD(use_ignore).set_default(false)\n-    .describe(\"If set to true, the ignore_label value will not contribute \"\n-      \"to the backward gradient\");\n+    .describe(\"If set to ``true``, the `ignore_label` value will not contribute \"\n+              \"to the backward gradient.\");\n     DMLC_DECLARE_FIELD(preserve_shape).set_default(false)\n-    .describe(\"If true, softmax will applied on the last axis\");\n+    .describe(\"If set to ``true``, the softmax function will be computed along with \"\n+              \"the last axis.\");\n     DMLC_DECLARE_FIELD(normalization)\n     .add_enum(\"null\", softmaxout_enum::kNull)\n     .add_enum(\"batch\", softmaxout_enum::kBatch)\n     .add_enum(\"valid\", softmaxout_enum::kValid)\n     .set_default(softmaxout_enum::kNull)\n-    .describe(\"Normalize the gradient\");\n+    .describe(\"Normalize the gradient.\");\n     DMLC_DECLARE_FIELD(out_grad)\n     .set_default(false)\n-    .describe(\"Apply weighting from output gradient\");\n+    .describe(\"Multiply gradient with output gradient element-wise.\");","path":"src/operator/softmax_output-inl.h","position":35,"original_position":35,"commit_id":"f2f47a2a92a637a8bd2b9c1b203147ec3d7ec22e","original_commit_id":"f2f47a2a92a637a8bd2b9c1b203147ec3d7ec22e","user":{"login":"madjam","id":8388825,"avatar_url":"https://avatars3.githubusercontent.com/u/8388825?v=3","gravatar_id":"","url":"https://api.github.com/users/madjam","html_url":"https://github.com/madjam","followers_url":"https://api.github.com/users/madjam/followers","following_url":"https://api.github.com/users/madjam/following{/other_user}","gists_url":"https://api.github.com/users/madjam/gists{/gist_id}","starred_url":"https://api.github.com/users/madjam/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/madjam/subscriptions","organizations_url":"https://api.github.com/users/madjam/orgs","repos_url":"https://api.github.com/users/madjam/repos","events_url":"https://api.github.com/users/madjam/events{/privacy}","received_events_url":"https://api.github.com/users/madjam/received_events","type":"User","site_admin":false},"body":"Multiply -> Multiplies","created_at":"2017-04-26T21:36:35Z","updated_at":"2017-04-26T21:39:09Z","html_url":"https://github.com/dmlc/mxnet/pull/5945#discussion_r113569042","pull_request_url":"https://api.github.com/repos/dmlc/mxnet/pulls/5945","_links":{"self":{"href":"https://api.github.com/repos/dmlc/mxnet/pulls/comments/113569042"},"html":{"href":"https://github.com/dmlc/mxnet/pull/5945#discussion_r113569042"},"pull_request":{"href":"https://api.github.com/repos/dmlc/mxnet/pulls/5945"}}},"pull_request":{"url":"https://api.github.com/repos/dmlc/mxnet/pulls/5945","id":117136262,"html_url":"https://github.com/dmlc/mxnet/pull/5945","diff_url":"https://github.com/dmlc/mxnet/pull/5945.diff","patch_url":"https://github.com/dmlc/mxnet/pull/5945.patch","issue_url":"https://api.github.com/repos/dmlc/mxnet/issues/5945","number":5945,"state":"open","locked":false,"title":"doc improvement - SoftmaxOutput, and metrics","user":{"login":"jiajiechen","id":9403337,"avatar_url":"https://avatars3.githubusercontent.com/u/9403337?v=3","gravatar_id":"","url":"https://api.github.com/users/jiajiechen","html_url":"https://github.com/jiajiechen","followers_url":"https://api.github.com/users/jiajiechen/followers","following_url":"https://api.github.com/users/jiajiechen/following{/other_user}","gists_url":"https://api.github.com/users/jiajiechen/gists{/gist_id}","starred_url":"https://api.github.com/users/jiajiechen/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jiajiechen/subscriptions","organizations_url":"https://api.github.com/users/jiajiechen/orgs","repos_url":"https://api.github.com/users/jiajiechen/repos","events_url":"https://api.github.com/users/jiajiechen/events{/privacy}","received_events_url":"https://api.github.com/users/jiajiechen/received_events","type":"User","site_admin":false},"body":"* SoftmaxOutput\r\n\r\n* softmax_cross_entropy\r\n\r\n* Initializer\r\n    * constant\r\n\r\n* minor fixes in some descriptions that have render problems because of incorrect indentation.\r\n\r\n@mli @madjam @zackchase @nswamy @indhub @Roshrini\r\n\r\n<img width=\"1000\" alt=\"screen shot 2017-04-22 at 9 44 29 pm\" src=\"https://cloud.githubusercontent.com/assets/9403337/25310875/174b3ada-27a5-11e7-9fa9-22d512f4ebcd.png\">\r\n<img width=\"359\" alt=\"screen shot 2017-04-22 at 9 44 55 pm\" src=\"https://cloud.githubusercontent.com/assets/9403337/25310876/1af37620-27a5-11e7-8176-fdff89bd4762.png\">\r\n<img width=\"875\" alt=\"screen shot 2017-04-22 at 9 43 34 pm\" src=\"https://cloud.githubusercontent.com/assets/9403337/25310877/1efbb8d6-27a5-11e7-999f-5bf0acce5570.png\">\r\n","created_at":"2017-04-23T04:41:52Z","updated_at":"2017-04-26T21:39:09Z","closed_at":null,"merged_at":null,"merge_commit_sha":"e200468989e67024acd75efbb698ccf5bd64914b","assignee":null,"assignees":[],"milestone":null,"commits_url":"https://api.github.com/repos/dmlc/mxnet/pulls/5945/commits","review_comments_url":"https://api.github.com/repos/dmlc/mxnet/pulls/5945/comments","review_comment_url":"https://api.github.com/repos/dmlc/mxnet/pulls/comments{/number}","comments_url":"https://api.github.com/repos/dmlc/mxnet/issues/5945/comments","statuses_url":"https://api.github.com/repos/dmlc/mxnet/statuses/f2f47a2a92a637a8bd2b9c1b203147ec3d7ec22e","head":{"label":"jiajiechen:doc-change-3","ref":"doc-change-3","sha":"f2f47a2a92a637a8bd2b9c1b203147ec3d7ec22e","user":{"login":"jiajiechen","id":9403337,"avatar_url":"https://avatars3.githubusercontent.com/u/9403337?v=3","gravatar_id":"","url":"https://api.github.com/users/jiajiechen","html_url":"https://github.com/jiajiechen","followers_url":"https://api.github.com/users/jiajiechen/followers","following_url":"https://api.github.com/users/jiajiechen/following{/other_user}","gists_url":"https://api.github.com/users/jiajiechen/gists{/gist_id}","starred_url":"https://api.github.com/users/jiajiechen/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jiajiechen/subscriptions","organizations_url":"https://api.github.com/users/jiajiechen/orgs","repos_url":"https://api.github.com/users/jiajiechen/repos","events_url":"https://api.github.com/users/jiajiechen/events{/privacy}","received_events_url":"https://api.github.com/users/jiajiechen/received_events","type":"User","site_admin":false},"repo":{"id":85985124,"name":"mxnet","full_name":"jiajiechen/mxnet","owner":{"login":"jiajiechen","id":9403337,"avatar_url":"https://avatars3.githubusercontent.com/u/9403337?v=3","gravatar_id":"","url":"https://api.github.com/users/jiajiechen","html_url":"https://github.com/jiajiechen","followers_url":"https://api.github.com/users/jiajiechen/followers","following_url":"https://api.github.com/users/jiajiechen/following{/other_user}","gists_url":"https://api.github.com/users/jiajiechen/gists{/gist_id}","starred_url":"https://api.github.com/users/jiajiechen/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jiajiechen/subscriptions","organizations_url":"https://api.github.com/users/jiajiechen/orgs","repos_url":"https://api.github.com/users/jiajiechen/repos","events_url":"https://api.github.com/users/jiajiechen/events{/privacy}","received_events_url":"https://api.github.com/users/jiajiechen/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/jiajiechen/mxnet","description":"Lightweight, Portable, Flexible Distributed/Mobile Deep Learning with Dynamic, Mutation-aware Dataflow Dep Scheduler; for Python, R, Julia, Scala, Go, Javascript and more","fork":true,"url":"https://api.github.com/repos/jiajiechen/mxnet","forks_url":"https://api.github.com/repos/jiajiechen/mxnet/forks","keys_url":"https://api.github.com/repos/jiajiechen/mxnet/keys{/key_id}","collaborators_url":"https://api.github.com/repos/jiajiechen/mxnet/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/jiajiechen/mxnet/teams","hooks_url":"https://api.github.com/repos/jiajiechen/mxnet/hooks","issue_events_url":"https://api.github.com/repos/jiajiechen/mxnet/issues/events{/number}","events_url":"https://api.github.com/repos/jiajiechen/mxnet/events","assignees_url":"https://api.github.com/repos/jiajiechen/mxnet/assignees{/user}","branches_url":"https://api.github.com/repos/jiajiechen/mxnet/branches{/branch}","tags_url":"https://api.github.com/repos/jiajiechen/mxnet/tags","blobs_url":"https://api.github.com/repos/jiajiechen/mxnet/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/jiajiechen/mxnet/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/jiajiechen/mxnet/git/refs{/sha}","trees_url":"https://api.github.com/repos/jiajiechen/mxnet/git/trees{/sha}","statuses_url":"https://api.github.com/repos/jiajiechen/mxnet/statuses/{sha}","languages_url":"https://api.github.com/repos/jiajiechen/mxnet/languages","stargazers_url":"https://api.github.com/repos/jiajiechen/mxnet/stargazers","contributors_url":"https://api.github.com/repos/jiajiechen/mxnet/contributors","subscribers_url":"https://api.github.com/repos/jiajiechen/mxnet/subscribers","subscription_url":"https://api.github.com/repos/jiajiechen/mxnet/subscription","commits_url":"https://api.github.com/repos/jiajiechen/mxnet/commits{/sha}","git_commits_url":"https://api.github.com/repos/jiajiechen/mxnet/git/commits{/sha}","comments_url":"https://api.github.com/repos/jiajiechen/mxnet/comments{/number}","issue_comment_url":"https://api.github.com/repos/jiajiechen/mxnet/issues/comments{/number}","contents_url":"https://api.github.com/repos/jiajiechen/mxnet/contents/{+path}","compare_url":"https://api.github.com/repos/jiajiechen/mxnet/compare/{base}...{head}","merges_url":"https://api.github.com/repos/jiajiechen/mxnet/merges","archive_url":"https://api.github.com/repos/jiajiechen/mxnet/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/jiajiechen/mxnet/downloads","issues_url":"https://api.github.com/repos/jiajiechen/mxnet/issues{/number}","pulls_url":"https://api.github.com/repos/jiajiechen/mxnet/pulls{/number}","milestones_url":"https://api.github.com/repos/jiajiechen/mxnet/milestones{/number}","notifications_url":"https://api.github.com/repos/jiajiechen/mxnet/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/jiajiechen/mxnet/labels{/name}","releases_url":"https://api.github.com/repos/jiajiechen/mxnet/releases{/id}","deployments_url":"https://api.github.com/repos/jiajiechen/mxnet/deployments","created_at":"2017-03-23T18:40:08Z","updated_at":"2017-03-23T18:40:14Z","pushed_at":"2017-04-26T21:17:26Z","git_url":"git://github.com/jiajiechen/mxnet.git","ssh_url":"git@github.com:jiajiechen/mxnet.git","clone_url":"https://github.com/jiajiechen/mxnet.git","svn_url":"https://github.com/jiajiechen/mxnet","homepage":"http://mxnet.io","size":16862,"stargazers_count":0,"watchers_count":0,"language":"C++","has_issues":false,"has_projects":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"dmlc:master","ref":"master","sha":"3d4d845e8150016212bff44a600d19a80f42f16b","user":{"login":"dmlc","id":11508361,"avatar_url":"https://avatars1.githubusercontent.com/u/11508361?v=3","gravatar_id":"","url":"https://api.github.com/users/dmlc","html_url":"https://github.com/dmlc","followers_url":"https://api.github.com/users/dmlc/followers","following_url":"https://api.github.com/users/dmlc/following{/other_user}","gists_url":"https://api.github.com/users/dmlc/gists{/gist_id}","starred_url":"https://api.github.com/users/dmlc/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dmlc/subscriptions","organizations_url":"https://api.github.com/users/dmlc/orgs","repos_url":"https://api.github.com/users/dmlc/repos","events_url":"https://api.github.com/users/dmlc/events{/privacy}","received_events_url":"https://api.github.com/users/dmlc/received_events","type":"Organization","site_admin":false},"repo":{"id":34864402,"name":"mxnet","full_name":"dmlc/mxnet","owner":{"login":"dmlc","id":11508361,"avatar_url":"https://avatars1.githubusercontent.com/u/11508361?v=3","gravatar_id":"","url":"https://api.github.com/users/dmlc","html_url":"https://github.com/dmlc","followers_url":"https://api.github.com/users/dmlc/followers","following_url":"https://api.github.com/users/dmlc/following{/other_user}","gists_url":"https://api.github.com/users/dmlc/gists{/gist_id}","starred_url":"https://api.github.com/users/dmlc/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dmlc/subscriptions","organizations_url":"https://api.github.com/users/dmlc/orgs","repos_url":"https://api.github.com/users/dmlc/repos","events_url":"https://api.github.com/users/dmlc/events{/privacy}","received_events_url":"https://api.github.com/users/dmlc/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/dmlc/mxnet","description":"Lightweight, Portable, Flexible Distributed/Mobile Deep Learning with Dynamic, Mutation-aware Dataflow Dep Scheduler; for Python, R, Julia, Scala, Go, Javascript and more","fork":false,"url":"https://api.github.com/repos/dmlc/mxnet","forks_url":"https://api.github.com/repos/dmlc/mxnet/forks","keys_url":"https://api.github.com/repos/dmlc/mxnet/keys{/key_id}","collaborators_url":"https://api.github.com/repos/dmlc/mxnet/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/dmlc/mxnet/teams","hooks_url":"https://api.github.com/repos/dmlc/mxnet/hooks","issue_events_url":"https://api.github.com/repos/dmlc/mxnet/issues/events{/number}","events_url":"https://api.github.com/repos/dmlc/mxnet/events","assignees_url":"https://api.github.com/repos/dmlc/mxnet/assignees{/user}","branches_url":"https://api.github.com/repos/dmlc/mxnet/branches{/branch}","tags_url":"https://api.github.com/repos/dmlc/mxnet/tags","blobs_url":"https://api.github.com/repos/dmlc/mxnet/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/dmlc/mxnet/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/dmlc/mxnet/git/refs{/sha}","trees_url":"https://api.github.com/repos/dmlc/mxnet/git/trees{/sha}","statuses_url":"https://api.github.com/repos/dmlc/mxnet/statuses/{sha}","languages_url":"https://api.github.com/repos/dmlc/mxnet/languages","stargazers_url":"https://api.github.com/repos/dmlc/mxnet/stargazers","contributors_url":"https://api.github.com/repos/dmlc/mxnet/contributors","subscribers_url":"https://api.github.com/repos/dmlc/mxnet/subscribers","subscription_url":"https://api.github.com/repos/dmlc/mxnet/subscription","commits_url":"https://api.github.com/repos/dmlc/mxnet/commits{/sha}","git_commits_url":"https://api.github.com/repos/dmlc/mxnet/git/commits{/sha}","comments_url":"https://api.github.com/repos/dmlc/mxnet/comments{/number}","issue_comment_url":"https://api.github.com/repos/dmlc/mxnet/issues/comments{/number}","contents_url":"https://api.github.com/repos/dmlc/mxnet/contents/{+path}","compare_url":"https://api.github.com/repos/dmlc/mxnet/compare/{base}...{head}","merges_url":"https://api.github.com/repos/dmlc/mxnet/merges","archive_url":"https://api.github.com/repos/dmlc/mxnet/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/dmlc/mxnet/downloads","issues_url":"https://api.github.com/repos/dmlc/mxnet/issues{/number}","pulls_url":"https://api.github.com/repos/dmlc/mxnet/pulls{/number}","milestones_url":"https://api.github.com/repos/dmlc/mxnet/milestones{/number}","notifications_url":"https://api.github.com/repos/dmlc/mxnet/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/dmlc/mxnet/labels{/name}","releases_url":"https://api.github.com/repos/dmlc/mxnet/releases{/id}","deployments_url":"https://api.github.com/repos/dmlc/mxnet/deployments","created_at":"2015-04-30T16:21:15Z","updated_at":"2017-04-26T19:55:09Z","pushed_at":"2017-04-26T21:32:19Z","git_url":"git://github.com/dmlc/mxnet.git","ssh_url":"git@github.com:dmlc/mxnet.git","clone_url":"https://github.com/dmlc/mxnet.git","svn_url":"https://github.com/dmlc/mxnet","homepage":"http://mxnet.io","size":16869,"stargazers_count":9380,"watchers_count":9380,"language":"C++","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":3529,"mirror_url":null,"open_issues_count":1559,"forks":3529,"open_issues":1559,"watchers":9380,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/dmlc/mxnet/pulls/5945"},"html":{"href":"https://github.com/dmlc/mxnet/pull/5945"},"issue":{"href":"https://api.github.com/repos/dmlc/mxnet/issues/5945"},"comments":{"href":"https://api.github.com/repos/dmlc/mxnet/issues/5945/comments"},"review_comments":{"href":"https://api.github.com/repos/dmlc/mxnet/pulls/5945/comments"},"review_comment":{"href":"https://api.github.com/repos/dmlc/mxnet/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/dmlc/mxnet/pulls/5945/commits"},"statuses":{"href":"https://api.github.com/repos/dmlc/mxnet/statuses/f2f47a2a92a637a8bd2b9c1b203147ec3d7ec22e"}}}}
{"actor":{"display_login":"madjam"}}