Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Matrix documentation #253

Merged
merged 3 commits into from
Oct 3, 2022
Merged

Matrix documentation #253

merged 3 commits into from
Oct 3, 2022

Conversation

celikbasak
Copy link
Member

Overview

  • Matrix speller documentation updated.
  • AUC calculation documentation added.

Ticket

Matrix Documentation: https://www.pivotaltracker.com/story/show/182005879
AUC Documentation: https://www.pivotaltracker.com/story/show/178043288

Contributions

  • Matrix Speller documentation added to main README.md, display/paradigm/matrix/display.py and task/paradigm/matrix/calibration.py
  • AUC calculation is added to signal/model/README.md. Detailed explanation in Readme on what does the AUC mean in our PCA/RDA concept. Further mathematical explanation provided in pca_rda_kde/cross_validation.py and pca_rda_kde/pca_rda_kde.py/evaluate are confirmed to be up-to-date.

Test

  • Linting and testing are completed.

Documentation

  • Documentation is added to relevant README.md files.

Changelog

  • CHANGELOG.md is updated.

@tab-cmd tab-cmd merged commit 9541aa1 into 2.0.0rc2 Oct 3, 2022
tab-cmd added a commit that referenced this pull request Oct 3, 2022
* add timer to prevent double clicking (#218)

* #181963356 ; added better alerting to inform users when fake data mode is on

* Added changelog entry

* Refactoring to reduce duplication

* #182040775 ; option to summarize session at the end of a copy phrase task

* Update README.md

High level GPT2 documentation added, word level prediction described, contact information added

* Matrix Display Fixes (#221)

* fixes bug with last stimuli lagging in matrix calibration, added entire grid flash before each inquiry

* Address PR comment   cleanup

Co-authored-by: Tab Memmott <[email protected]>

* Refactored session helper to generate spreadsheets without first creating a sqlite database

* ERP plotting improvements and MNE data support (#220)

* #182005453 ; added parameter for signal model path; updated initialization code to use this for typing tasks

* #182406904 ; Fix bug when generating a spreadsheet from active session data

* [Bug fix] Two presses needed to start copy phrase (#225)

* Documentation and formatting

* #182200897 ; check for internet connection and confirm before proceeding with the session

* Added logging for GPU information, if available

* Whitespace fix

* Added changes

* Move session validation to validate module; update internet connectivity test to work with VPN

* #182106570 ; added functionality for configuration channel specifications for a given device.

* Added a test mock to prevent a GUI interaction during testing

* Fix test issue by switching to a different acquisition client for mocking

* use a better default timeout (#228)

* #182776686 ; prevent widgets scrolling on parameters form

* Jitter (#233)

Jitter for calibration   parameter. copy phrase ip

cleanup stimuli tests

* User ID reset bug and cleanup (#235)

User id reset fix

* Add support for Tobii Nano (#234)

* Add support for Tobii Nano

* address PR feedback

* update changelog

* added ssvep to cvep method (#232)

Co-authored-by: Aida Fakhry <[email protected]>
Co-authored-by: Tab Memmott <[email protected]>

* #183037159 ; alert when using battery power

* Better documentation on return values and potential impacts

* VEP Display (#237)

* upgrade psychopy  (#239)

* ERP viz demo fix (#240)

* #175193924 infrastructure for changed parameters ; #183134229 Fixed issue with params_form rounding some float values ; #183133776  allow static offset to be input with more precision

* Remove unneeded parameters  (#241)

* signal model loaded log (#244)

better signal model logging

* Devices config update && BciPy running outside of root (#242)

* Refactor param changes GUI to use a scroll area for displaying a large number of changes

* Refinements; parameters changes start out collapsed if empty; minor refactorings

* #182408060 ; Ensure that spelled text is provided to the language model when using fake data

* Export the device used as a useable config file (#247)

* Convert: add BDF support and fix static offset bug (#246)

* #182031676 ; remove TCP-based acquisition code

* Added PR number to changelog

* Added function type information; better string representations of channel specs and device specs; removed unused code in tests

* Updated max_buffer_len parameter name for lsl_client

* fix rebase issue in parameters module

* Bug fixes: jitter, offline analysis, task complete alerting  (#250)

* Matrix Bug: fix for scp flashing (#252)

* Matrix documentation (#253)

Co-authored-by: lawhead <[email protected]>
Co-authored-by: Shijia Liu <37078018 [email protected]>
Co-authored-by: jcgangemi1 <87331189 [email protected]>
Co-authored-by: AidaFakhry <92689243 [email protected]>
Co-authored-by: Aida Fakhry <[email protected]>
Co-authored-by: Basak Celik <[email protected]>
@tab-cmd tab-cmd deleted the matrix_documentation branch October 31, 2022 20:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants