{"action":"created","issue":{"url":"https://api.github.com/repos/librosa/librosa/issues/701","repository_url":"https://api.github.com/repos/librosa/librosa","labels_url":"https://api.github.com/repos/librosa/librosa/issues/701/labels{/name}","comments_url":"https://api.github.com/repos/librosa/librosa/issues/701/comments","events_url":"https://api.github.com/repos/librosa/librosa/issues/701/events","html_url":"https://github.com/librosa/librosa/pull/701","id":316615301,"number":701,"title":"Document mel_frequencies","user":{"login":"lostanlen","id":3943142,"avatar_url":"https://avatars1.githubusercontent.com/u/3943142?v=4","gravatar_id":"","url":"https://api.github.com/users/lostanlen","html_url":"https://github.com/lostanlen","followers_url":"https://api.github.com/users/lostanlen/followers","following_url":"https://api.github.com/users/lostanlen/following{/other_user}","gists_url":"https://api.github.com/users/lostanlen/gists{/gist_id}","starred_url":"https://api.github.com/users/lostanlen/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/lostanlen/subscriptions","organizations_url":"https://api.github.com/users/lostanlen/orgs","repos_url":"https://api.github.com/users/lostanlen/repos","events_url":"https://api.github.com/users/lostanlen/events{/privacy}","received_events_url":"https://api.github.com/users/lostanlen/received_events","type":"User","site_admin":false},"labels":[{"id":208911196,"url":"https://api.github.com/repos/librosa/librosa/labels/documentation","name":"documentation","color":"009800","default":false}],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":{"url":"https://api.github.com/repos/librosa/librosa/milestones/15","html_url":"https://github.com/librosa/librosa/milestone/15","labels_url":"https://api.github.com/repos/librosa/librosa/milestones/15/labels","id":2912678,"number":15,"title":"0.6.1","description":null,"creator":{"login":"bmcfee","id":1190540,"avatar_url":"https://avatars3.githubusercontent.com/u/1190540?v=4","gravatar_id":"","url":"https://api.github.com/users/bmcfee","html_url":"https://github.com/bmcfee","followers_url":"https://api.github.com/users/bmcfee/followers","following_url":"https://api.github.com/users/bmcfee/following{/other_user}","gists_url":"https://api.github.com/users/bmcfee/gists{/gist_id}","starred_url":"https://api.github.com/users/bmcfee/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/bmcfee/subscriptions","organizations_url":"https://api.github.com/users/bmcfee/orgs","repos_url":"https://api.github.com/users/bmcfee/repos","events_url":"https://api.github.com/users/bmcfee/events{/privacy}","received_events_url":"https://api.github.com/users/bmcfee/received_events","type":"User","site_admin":false},"open_issues":5,"closed_issues":12,"state":"open","created_at":"2017-11-14T20:25:04Z","updated_at":"2018-04-23T14:59:14Z","due_on":null,"closed_at":null},"comments":13,"created_at":"2018-04-22T21:32:24Z","updated_at":"2018-04-27T23:29:33Z","closed_at":null,"author_association":"CONTRIBUTOR","pull_request":{"url":"https://api.github.com/repos/librosa/librosa/pulls/701","html_url":"https://github.com/librosa/librosa/pull/701","diff_url":"https://github.com/librosa/librosa/pull/701.diff","patch_url":"https://github.com/librosa/librosa/pull/701.patch"},"body":"#### Reference Issue\r\nAs @stefan-balke pointed out in #642, our documentation of the mel scale is rather lapidary, and lacks references to the toolboxes it replicates, namely Slaney's MATLAB Auditory Toolbox and Cambridge's Hidden Markov Toolkit.\r\n\r\n#### What does this implement/fix? Explain your changes.\r\nI wrote two paragraphs explaining what the mel scale is in layperson's terms, and explaining the difference between Auditory toolbox (our default) and HTK, so that the user is informed of the choice.\r\nNB: some of the wording in this commit is from my ISMIR 2016 paper (CC BY 4.0), but I hereby declare that I don't need attribution for it, and am happy to make it part of librosa (ISC license).\r\n\r\n\r\n#### Any other comments?\r\nI decided to document `mel_frequencies` rather than lower functions in the call chain (`hz_to_mel` and `mel_to_hz`) or higher functions in the call chain (`mel_filterbank`, `melspectrogram`, `mfcc`) because I feel like this is the function where we'd expect some explanation. This function is essentially a vectorized form of `hz_to_mel`. In practice I use this one much more often than `hz_to_mel`. Same for `mel_filterbank` which is rarely called by the user themself.\n\n<!-- Reviewable:start -->\n---\nThis change is [<img src=\"https://reviewable.io/review_button.svg\" height=\"34\" align=\"absmiddle\" alt=\"Reviewable\"/>](https://reviewable.io/reviews/librosa/librosa/701)\n<!-- Reviewable:end -->\n"},"comment":{"url":"https://api.github.com/repos/librosa/librosa/issues/comments/385118412","html_url":"https://github.com/librosa/librosa/pull/701#issuecomment-385118412","issue_url":"https://api.github.com/repos/librosa/librosa/issues/701","id":385118412,"user":{"login":"lostanlen","id":3943142,"avatar_url":"https://avatars1.githubusercontent.com/u/3943142?v=4","gravatar_id":"","url":"https://api.github.com/users/lostanlen","html_url":"https://github.com/lostanlen","followers_url":"https://api.github.com/users/lostanlen/followers","following_url":"https://api.github.com/users/lostanlen/following{/other_user}","gists_url":"https://api.github.com/users/lostanlen/gists{/gist_id}","starred_url":"https://api.github.com/users/lostanlen/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/lostanlen/subscriptions","organizations_url":"https://api.github.com/users/lostanlen/orgs","repos_url":"https://api.github.com/users/lostanlen/repos","events_url":"https://api.github.com/users/lostanlen/events{/privacy}","received_events_url":"https://api.github.com/users/lostanlen/received_events","type":"User","site_admin":false},"created_at":"2018-04-27T23:29:33Z","updated_at":"2018-04-27T23:29:33Z","author_association":"CONTRIBUTOR","body":"Thanks @stefan-balke. Sorry I did not use the reviewable interface, I did not understand how to use it."}}
{"actor":{"display_login":"lostanlen"}}