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

Overview tutorial (create or polish) #732

Closed
12 tasks done
cwmeijer opened this issue Mar 20, 2024 · 5 comments · Fixed by #776
Closed
12 tasks done

Overview tutorial (create or polish) #732

cwmeijer opened this issue Mar 20, 2024 · 5 comments · Fixed by #776
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@cwmeijer
Copy link
Member

cwmeijer commented Mar 20, 2024

  • Rename the demo notebook to Overview
  • Edit the Getting started section from the main README. Point to the overview notebook in the main README.
  • Split the notebook into 2 sections: explainers and data modalities

Move the Getting Started examples from the main README to the overview notebook

  • Text example
  • Image example
  • TS example
  • Tabular example

++++++++++++++++++++++++++


Below are the original ideas for this issue:

Maybe the demo notebook is a good starting point.
Make it a nice generic tutorial.
Make sure it is linked to from the right places in our readme and tutorial readme.
Consider removing/shortening the Getting Started README section and moving the content to the demo notebook. See also #721.

@elboyran elboyran self-assigned this May 22, 2024
@elboyran elboyran added documentation Improvements or additions to documentation standup Temp label- for disscussion with the team next standup and removed standup Temp label- for disscussion with the team next standup labels May 22, 2024
@elboyran elboyran changed the title create or polish generic tutorial Overview tutorial (create or polish) May 22, 2024
@elboyran elboyran linked a pull request May 24, 2024 that will close this issue
@elboyran elboyran removed a link to a pull request May 31, 2024
@elboyran
Copy link
Contributor

elboyran commented May 31, 2024

Issue #755 addressed by commits 643b478 and c461e7c. The tutorial is extended by 1302a4f. These extensions raise questions about RISE on text!

@elboyran
Copy link
Contributor

New structure of the overview notebook, Colab and root directory settings; text and image examples are addressed by eb1b5df.

@elboyran
Copy link
Contributor

Time-series example (RISE on simple extreme temp days) added by 8bd8c52.

@elboyran
Copy link
Contributor

Tabular regression example added by fdd7229.

@elboyran
Copy link
Contributor

The documentation looks also nice now ;-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

2 participants