RAPID-MIX_API issueshttps://gitlab.doc.gold.ac.uk/rapid-mix/RAPID-MIX_API/-/issues2017-09-20T12:40:44Zhttps://gitlab.doc.gold.ac.uk/rapid-mix/RAPID-MIX_API/-/issues/31Contrasting examples2017-09-20T12:40:44ZFrancisco BernardoContrasting examplesWe have insufficient examples that contrast how to use different machine learning tasks (classification vs regression).
Recommendation: Create examples that demonstrate how to use classification AND regression, or classification AND DTW"We have insufficient examples that contrast how to use different machine learning tasks (classification vs regression).
Recommendation: Create examples that demonstrate how to use classification AND regression, or classification AND DTW"https://gitlab.doc.gold.ac.uk/rapid-mix/RAPID-MIX_API/-/issues/28Self-explanatory code and commenting practices2017-09-20T12:31:53ZFrancisco BernardoSelf-explanatory code and commenting practicesUsers considered code comments as important as documentation. Code comments compete with the main documentation, particularly for certain users who bypassed documentation completely, or who prefer to refer to it much later in the explora...Users considered code comments as important as documentation. Code comments compete with the main documentation, particularly for certain users who bypassed documentation completely, or who prefer to refer to it much later in the exploration and development workflow, for troubleshooting for instance.
Recommendations:
* Examples' code should be comprehensively commented in sections with “magic numbers” (e.g. number 5 in RapidStream, number of Gaussians, etc.)"
* Examples such as the RapidStream would benefit from adding the rationale and usefulness for each feature in the UI.https://gitlab.doc.gold.ac.uk/rapid-mix/RAPID-MIX_API/-/issues/26Providing an incremental approach for learning how to use the API2017-09-20T12:16:21ZFrancisco BernardoProviding an incremental approach for learning how to use the APIUsers suggested of structuring documentation with an "incremental approach", as "recipes", or short stories. Nature of Code was reference of providing a good incremental approach.
Recommendation: Provide guides grounded on specific u...Users suggested of structuring documentation with an "incremental approach", as "recipes", or short stories. Nature of Code was reference of providing a good incremental approach.
Recommendation: Provide guides grounded on specific use cases that show how to implement an incremental approach. For instance, the mouse examples are good candidates to illustrate how to start how to evolve from a barebones example with pre-defined data, to using real-time data, to mixing classification and regression, through to building up a more compelling use case grounded on real world scenario.https://gitlab.doc.gold.ac.uk/rapid-mix/RAPID-MIX_API/-/issues/25Provide further resources for the different underlying algorithms2017-09-20T12:10:27ZFrancisco BernardoProvide further resources for the different underlying algorithmsThe conceptual part about algorithms was considered both important and lacking. Users asked for more insights about how the algorithms worked.
Recommendation: Provide a succinct explanation with links to further resources, links to ext...The conceptual part about algorithms was considered both important and lacking. Users asked for more insights about how the algorithms worked.
Recommendation: Provide a succinct explanation with links to further resources, links to external 3rd party resources, such as videos, papers, etchttps://gitlab.doc.gold.ac.uk/rapid-mix/RAPID-MIX_API/-/issues/24Introduce supporting technologies (git, terminal, node, etc) or link to curat...2017-09-20T12:00:55ZFrancisco BernardoIntroduce supporting technologies (git, terminal, node, etc) or link to curated 3rd party resourcesSupporting technologies such as git, terminal, node, server-side technologies should be explained better.
Recommendation: Either with a very succinct explanation about rational and procedure, and/or a link to a good external resource th...Supporting technologies such as git, terminal, node, server-side technologies should be explained better.
Recommendation: Either with a very succinct explanation about rational and procedure, and/or a link to a good external resource that is compatible with our and language style.https://gitlab.doc.gold.ac.uk/rapid-mix/RAPID-MIX_API/-/issues/9Setup forum2017-09-20T11:12:58ZMichael ZbyszyńskiSetup forumWe've talked about having a user forum on the website. We should decide how to do that and implement it.We've talked about having a user forum on the website. We should decide how to do that and implement it.Michael ZbyszyńskiMichael Zbyszyński