RAPID-MIX_API issueshttps://gitlab.doc.gold.ac.uk/rapid-mix/RAPID-MIX_API/-/issues2017-10-24T10:55:01Zhttps://gitlab.doc.gold.ac.uk/rapid-mix/RAPID-MIX_API/-/issues/42Document audio/signal processing on the website2017-10-24T10:55:01ZMichael ZbyszyńskiDocument audio/signal processing on the websiteWe need another page about basic signal processing and feature extraction on incoming audio.
Also, some explanation synthesis and sample playback using MaxiLib.We need another page about basic signal processing and feature extraction on incoming audio.
Also, some explanation synthesis and sample playback using MaxiLib.Michael ZbyszyńskiMichael Zbyszyńskihttps://gitlab.doc.gold.ac.uk/rapid-mix/RAPID-MIX_API/-/issues/34Communicating the Interactive Machine Learning workflow to users2017-09-20T13:35:28ZFrancisco BernardoCommunicating the Interactive Machine Learning workflow to usersThe interactive machine learning workflow is difficult to convey with static sources of descriptive knowledge, such as text (documentation, comments, etc.) and even code. This is because of of procedural nature that the workflow entails....The interactive machine learning workflow is difficult to convey with static sources of descriptive knowledge, such as text (documentation, comments, etc.) and even code. This is because of of procedural nature that the workflow entails. Live demonstrations have been working pretty well for us, but were not always there.
Recommendation: We should find way to complement the documentation with richer media. Richer media, such as video and animations, are more effective at communicating the procedural nature of the workflow and yield better adoption.https://gitlab.doc.gold.ac.uk/rapid-mix/RAPID-MIX_API/-/issues/33API documentation fragmentation2017-09-20T13:04:40ZFrancisco BernardoAPI documentation fragmentationUsers' feedback reports about how the documentation of the different components is fragmented: different sites; different content, design and user experiences, and potentially, different authors.
Recommendations:
* There should be a ...Users' feedback reports about how the documentation of the different components is fragmented: different sites; different content, design and user experiences, and potentially, different authors.
Recommendations:
* There should be a common medium, method and style for documentation, which will reduce the adoption friction.
* ORM for MySQL, Postgres, loadash, underscore, KNX, and Processing, were given as reference examples of good documentation.https://gitlab.doc.gold.ac.uk/rapid-mix/RAPID-MIX_API/-/issues/32Explain the relation between inputs, classes, outputs and mapping2017-09-20T12:47:14ZFrancisco BernardoExplain the relation between inputs, classes, outputs and mappingOn the same note, how the relation between how inputs (or features) and outputs (or labels) is set was cumbersome. Some participants tried to train the same model with a different number of inputs.
Recommendation: In the case of compos...On the same note, how the relation between how inputs (or features) and outputs (or labels) is set was cumbersome. Some participants tried to train the same model with a different number of inputs.
Recommendation: In the case of composite labels (e.g. multiple regression outputs associated to the parameters of a synthesiser), it would be helpful to explain incrementally the rationale behind this, specially given this is one element that originates from our domain of practice and that makes our API highly opinionated.https://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/30Design patterns for using the RAPID-MIX API2017-09-20T12:59:27ZFrancisco BernardoDesign patterns for using the RAPID-MIX APIRAPID-MIX API users, as developers, would benefit from design patterns for macro or frequent use operations, that should be consistently implemented across examples.
Recommendations:
* Users would benefit from having the "record"...RAPID-MIX API users, as developers, would benefit from design patterns for macro or frequent use operations, that should be consistently implemented across examples.
Recommendations:
* Users would benefit from having the "record", "train" and "run" controls and modes made as visible and explicit as possible. A design pattern that unifies this kind of usage across examples, would provide a stronger scaffolding for understanding the RAPID-MIX workflow.
* Participants didn’t explore much feature selection in their process, sticking to what was given by default. Participants would benefit from a design pattern, or any scaffolding, that structures feature selection and the features meta-information across the examples.
* There aren’t many examples that save/load the “configuration data” (training data set or model). It would be useful to provide a design pattern for API examples that offers selection between pre-trained models (inputing stored training data, either from local or remote storage) and a new model to be trained from scratch, so that they can explore other features of the pipeline working with data, a feature selection and ML algorithms and parameters tuning.
* A design pattern that makes explicit the fast, realtime, and iterative nature of data streams, could benefit the users in understanding how to design with data. This could be achieved by rendering the feature vector or frame of data that is passed as input for training
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/23Providing the big picture of ML concepts and how they relate to our API2017-09-21T13:28:11ZFrancisco BernardoProviding the big picture of ML concepts and how they relate to our APIThere is no element in the documentation that provides a broad, encompassing and big picture of ML concepts and how our API provides them. Users at eNTERFACE17 suggested some useful artefacts for help with this, such as mind maps or info...There is no element in the documentation that provides a broad, encompassing and big picture of ML concepts and how our API provides them. Users at eNTERFACE17 suggested some useful artefacts for help with this, such as mind maps or infographics.
This should include terms such as "features", "feature vector", "model", "classifier", "instance", "example", "label", etc.
Recommendation: Provide a mind map embedded in a webpage of the RAPID-MIX API, which relate fundamental ML concepts to what our API offers to end users. There is a glossary of terms by Ron Kohavi (http://robotics.stanford.edu/~ronnyk/glossary.html) that could be mapped to this React MindMap component (https://github.com/learn-anything/react-mindmap). Checkout this example (https://learn-anything.xyz/machine-learning/machine-learning-libraries)https://gitlab.doc.gold.ac.uk/rapid-mix/RAPID-MIX_API/-/issues/22Documentation should explain the concept of "background class"2017-11-27T17:41:46ZFrancisco BernardoDocumentation should explain the concept of "background class"The use of background classes isn’t mentioned in the documentation. This was one of the strategies that users at eNTERFACE17 used to overcome classification and regression problems.
Recommendation: This is one concept that should be e...The use of background classes isn’t mentioned in the documentation. This was one of the strategies that users at eNTERFACE17 used to overcome classification and regression problems.
Recommendation: This is one concept that should be explained as it has a significant practical impact when setting up the classes and training the model. It would be beneficial to introduce it by using a Venn diagram with the "complement of a set", and relating this to the design space and design language
@rebeccaf Mentioned that Nick Gillian wrote about this, check this out.
https://gitlab.doc.gold.ac.uk/rapid-mix/RAPID-MIX_API/-/issues/21Regression requires additional explanation on the website2017-09-21T13:30:55ZFrancisco BernardoRegression requires additional explanation on the websiteRegression requires additional explanation, mainly with regards to :
* why is it different from interpolation
* why it doesn’t converge to the initial values
* ...Regression requires additional explanation, mainly with regards to :
* why is it different from interpolation
* why it doesn’t converge to the initial values
* ...https://gitlab.doc.gold.ac.uk/rapid-mix/RAPID-MIX_API/-/issues/20Refactor variable names in code snippets of the website2017-11-27T17:21:03ZFrancisco BernardoRefactor variable names in code snippets of the websiteVariable names across code snippets in the documentation should be consistent. This lessens the learning curve and memory workload of users.Variable names across code snippets in the documentation should be consistent. This lessens the learning curve and memory workload of users.