{"action":"created","issue":{"url":"https://api.github.com/repos/hawk31/pyGPGO/issues/7","repository_url":"https://api.github.com/repos/hawk31/pyGPGO","labels_url":"https://api.github.com/repos/hawk31/pyGPGO/issues/7/labels{/name}","comments_url":"https://api.github.com/repos/hawk31/pyGPGO/issues/7/comments","events_url":"https://api.github.com/repos/hawk31/pyGPGO/issues/7/events","html_url":"https://github.com/hawk31/pyGPGO/issues/7","id":265828616,"number":7,"title":"[JOSS]: More prose & clearer examples in online docs","user":{"login":"dfm","id":350282,"avatar_url":"https://avatars3.githubusercontent.com/u/350282?v=4","gravatar_id":"","url":"https://api.github.com/users/dfm","html_url":"https://github.com/dfm","followers_url":"https://api.github.com/users/dfm/followers","following_url":"https://api.github.com/users/dfm/following{/other_user}","gists_url":"https://api.github.com/users/dfm/gists{/gist_id}","starred_url":"https://api.github.com/users/dfm/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dfm/subscriptions","organizations_url":"https://api.github.com/users/dfm/orgs","repos_url":"https://api.github.com/users/dfm/repos","events_url":"https://api.github.com/users/dfm/events{/privacy}","received_events_url":"https://api.github.com/users/dfm/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":2,"created_at":"2017-10-16T16:15:55Z","updated_at":"2017-10-21T14:45:40Z","closed_at":null,"author_association":"NONE","body":"I'm reviewing the JOSS submission at openjournals/joss-reviews#41 and most things are looking good, but I'll open a few issues here.\r\n\r\nTo be consistent with the JOSS requirements, the docs are going to need some work. At the moment, the documentation has a brief statement of need, a single example, and then API docs. More discussion should be included on the readthedocs page to make it easier to get started. This should include things like one or two tutorials (the `examples` directory is not sufficient - these examples don't even include any comments!), a page outlining the installation procedure, and a more detailed description of the available options.\r\n\r\nAnother thing that might be good to include is a comparison to some of the other existing Bayesian optimization packages that are already available in Python: [fmfn/BayesianOptimization](https://github.com/fmfn/BayesianOptimization), [GPyOpt](https://sheffieldml.github.io/GPyOpt/), and [skopt](https://scikit-optimize.github.io/) to name a few."},"comment":{"url":"https://api.github.com/repos/hawk31/pyGPGO/issues/comments/338407560","html_url":"https://github.com/hawk31/pyGPGO/issues/7#issuecomment-338407560","issue_url":"https://api.github.com/repos/hawk31/pyGPGO/issues/7","id":338407560,"user":{"login":"hawk31","id":6875576,"avatar_url":"https://avatars2.githubusercontent.com/u/6875576?v=4","gravatar_id":"","url":"https://api.github.com/users/hawk31","html_url":"https://github.com/hawk31","followers_url":"https://api.github.com/users/hawk31/followers","following_url":"https://api.github.com/users/hawk31/following{/other_user}","gists_url":"https://api.github.com/users/hawk31/gists{/gist_id}","starred_url":"https://api.github.com/users/hawk31/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/hawk31/subscriptions","organizations_url":"https://api.github.com/users/hawk31/orgs","repos_url":"https://api.github.com/users/hawk31/repos","events_url":"https://api.github.com/users/hawk31/events{/privacy}","received_events_url":"https://api.github.com/users/hawk31/received_events","type":"User","site_admin":false},"created_at":"2017-10-21T14:45:40Z","updated_at":"2017-10-21T14:45:40Z","author_association":"OWNER","body":"Hi @dfm !\r\n\r\n* Link to the documentation is now more visible in the repository, both in the header and in the `README.md` file. \r\n\r\n* Internal documentation links are now fixed. Thanks for noticing.\r\n\r\nLet me know again if further changes are required."}}
{"actor":{"display_login":"hawk31"}}