osl icon indicating copy to clipboard operation
osl copied to clipboard

Documentation improvements

Open matsvanes opened this issue 2 years ago • 1 comments

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 avatar Jan 11 '24 14:01 matsvanes

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.

matsvanes avatar Jan 12 '24 16:01 matsvanes

Fixed in #351

matsvanes avatar Oct 09 '24 08:10 matsvanes