Skip to content

docs: add how-to guide for embedding time-series data using CausalCNN and Transformer#1695

Merged
janfb merged 3 commits intosbi-dev:mainfrom
satwiksps:docs/howto-time-series-embedding
Nov 10, 2025
Merged

docs: add how-to guide for embedding time-series data using CausalCNN and Transformer#1695
janfb merged 3 commits intosbi-dev:mainfrom
satwiksps:docs/howto-time-series-embedding

Conversation

@satwiksps
Copy link
Contributor

Summary

This PR adds a new how-to guide demonstrating how to use CausalCNNEmbedding and TransformerEmbedding to handle sequential (time-series) data in sbi.

Details

Checklist

  • Notebook runs without errors
  • Added entry in docs/how_to_guide/index.rst
  • Verified build via make html
  • Consistent style with other how-to guides

Copy link
Contributor

@janfb janfb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks very good already!

I only have two minor comments and added one request for creating a related issue.

Copy link
Contributor

@janfb janfb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great addition to the docs, thanks a lot @satwiksps - well done! 👏

@codecov
Copy link

codecov bot commented Nov 10, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.62%. Comparing base (6ffe7b6) to head (9082781).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1695      +/-   ##
==========================================
- Coverage   88.48%   84.62%   -3.86%     
==========================================
  Files         137      137              
  Lines       11470    11470              
==========================================
- Hits        10149     9707     -442     
- Misses       1321     1763     +442     
Flag Coverage Δ
unittests 84.62% <ø> (-3.86%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 29 files with indirect coverage changes

@satwiksps
Copy link
Contributor Author

The CI run failed due to minor pre-commit / Ruff formatting issues (import order, unused import, and whitespace).
I’m addressing these locally and will push the corrected notebook shortly. Thanks for your patience!

@janfb janfb merged commit 06f13a8 into sbi-dev:main Nov 10, 2025
9 checks passed
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