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.

Sign up for GitHub

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

Jump to bottom

Documentation improvements #258

Open

matsvanes opened this issue Jan 11, 2024 · 1 comment

Labels

Collaborator

matsvanes commented Jan 11, 2024 •

edited

Keep track of the OSL paper requirements:

Put links in the API for the preproc config, and GLM design, pointing to tutorial. Ideally we improve documentation on how to build your config / design matrix (@AJQuinn )
implement tutorial to readthedocs

matsvanes added the documentation label

Collaborator Author

matsvanes commented Jan 12, 2024

THere are some errors in the GLM spectrum API. the GLM config has description:

config : :py:class:`glmtools.config.GLMConfig <glmtools.config.GLMConfig>`
            The  GLM configuration object.

But the config should actually be a sails.stft.GLMPeriodogramConfig.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment