Roadmap for v1.0

[raphaelvallat]

Ongoing PRs/Issues:

• Finalize evaluation module #166
• Save (more) persistent LightGBM trained classifiers for sleep staging #189
• Add yasa.Hypnogram.as_events() example #191
• Update plot_spectrogram to handle hypnograms with <5 stages #215
• Spindle amplitude is calculated on raw instead of bandpassed data #216

Remaining tasks

• Update changelog
• Update FAQ, specifically section on how to export yasa.SleepStaging output to visualization softwares
• Update quickstart
• Major cleaning of notebooks
• Brainstorm the return type of yasa.Hypnogra.upsample_to_data — should it be a yasa.Hypnogram instance, an array of string or an array of int?

Forgot anything @remrama?

---

Closed PRs

• First implementation of the Hypnogram class #116
• Hotfix for MNE plot_topomap deprecation #119
• Update simulate_hypno to return Hypnogram instance #121
• Add FutureWarning in hypnogram functions #123
• Hypnogram plot_hypnogram method #124
• Default dtype of pandas.Series is now a categorical #126
• SleepStaging returns a yasa.Hypnogram instance #127
• Update string representation of yasa.Hypnogram #129
• evaluation module #130
• Use PyData Sphinx Theme #179
• Use Pooch to download tutorial data #188

[remrama]

Looks great to me! If I think of anything else this is a good place to note it 👍