[Docs] Add e2e timeseries example to examples and release tests by crypdick · Pull Request #53488 · ray-project/ray

crypdick · 2025-06-02T20:51:09Z

Why are these changes needed?

This is the shipping the first notebook in an e2e timeseries tutorial. It has already been run through vale.

Related issue number

N/A

Checks

I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
I've run scripts/format.sh to lint the changes in this PR.
I've included any doc changes needed for https://docs.ray.io/en/master/.
- I've added any new APIs to the API Reference. For example, if I added a
  method in Tune, I've added it in doc/source/tune/api/ under the
  corresponding .rst file.
I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
Testing Strategy
- Unit tests
- Release tests
- This PR is not tested :(

Signed-off-by: Ricardo Decal <rdecal@anyscale.com>

doc/source/ray-overview/examples/e2e-timeseries/README.ipynb

doc/source/ray-overview/examples/e2e-timeseries/README.md

doc/source/ray-overview/examples/e2e-timeseries/ci/aws.yaml

doc/source/ray-overview/examples/e2e-timeseries/ci/test.py

Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com> Signed-off-by: Ricardo Decal <crypdick@users.noreply.github.com>

Signed-off-by: Ricardo Decal <rdecal@anyscale.com>

angelinalg

I stopped making the suggestions for the code comments because I think you get the idea. 😉

doc/source/ray-overview/examples/e2e-timeseries/e2e_timeseries/01-Distributed-Training.ipynb

…/01-Distributed-Training.ipynb Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com> Signed-off-by: Ricardo Decal <crypdick@users.noreply.github.com>

Signed-off-by: Ricardo Decal <crypdick@users.noreply.github.com>

Signed-off-by: Ricardo Decal <rdecal@anyscale.com>

angelinalg · 2025-06-04T03:42:35Z

Waiting for a review and approval from @GokuMohandas before enabling merge.

crypdick added 8 commits June 2, 2025 13:07

dump in files from e2e-ts repo

0f53ef1

Signed-off-by: Ricardo Decal <rdecal@anyscale.com>

add compute configs for gce/aws for ci and anyscale templates

acc9238

Signed-off-by: Ricardo Decal <rdecal@anyscale.com>

add index.rst

2127b23

Signed-off-by: Ricardo Decal <rdecal@anyscale.com>

teach vale about time-series

44f08ab

Signed-off-by: Ricardo Decal <rdecal@anyscale.com>

make vale happy

794247d

Signed-off-by: Ricardo Decal <rdecal@anyscale.com>

mark script as executable

f05c5a4

Signed-off-by: Ricardo Decal <rdecal@anyscale.com>

add to release tests

42414a0

Signed-off-by: Ricardo Decal <rdecal@anyscale.com>

create byod img

4c731be

Signed-off-by: Ricardo Decal <rdecal@anyscale.com>

crypdick requested review from a team as code owners June 2, 2025 20:51

crypdick added the docs An issue or change related to documentation label Jun 2, 2025

crypdick assigned crypdick and angelinalg and unassigned crypdick Jun 2, 2025

crypdick added the go add ONLY when ready to merge, run all tests label Jun 2, 2025

crypdick added 5 commits June 2, 2025 14:09

add e2e-timeseries example to documentation

3a85052

Signed-off-by: Ricardo Decal <rdecal@anyscale.com>

typo

953ff01

Signed-off-by: Ricardo Decal <rdecal@anyscale.com>

lint

2c4d399

Signed-off-by: Ricardo Decal <rdecal@anyscale.com>

drop editable install step

adbae33

Signed-off-by: Ricardo Decal <rdecal@anyscale.com>

vale

1125341

Signed-off-by: Ricardo Decal <rdecal@anyscale.com>

angelinalg reviewed Jun 2, 2025

View reviewed changes

crypdick and others added 9 commits June 2, 2025 14:44

Update doc/source/ray-overview/examples/e2e-timeseries/README.ipynb

9993793

Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com> Signed-off-by: Ricardo Decal <crypdick@users.noreply.github.com>

Update doc/source/ray-overview/examples/e2e-timeseries/README.md

5187f67

Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com> Signed-off-by: Ricardo Decal <crypdick@users.noreply.github.com>

Update doc/source/ray-overview/examples/e2e-timeseries/ci/aws.yaml

b2ea1c3

Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com> Signed-off-by: Ricardo Decal <crypdick@users.noreply.github.com>

Update doc/source/ray-overview/examples/e2e-timeseries/ci/test.py

9d2e4b1

Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com> Signed-off-by: Ricardo Decal <crypdick@users.noreply.github.com>

Update doc/source/ray-overview/examples/e2e-timeseries/ci/test.py

a28ec12

Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com> Signed-off-by: Ricardo Decal <crypdick@users.noreply.github.com>

Update doc/source/ray-overview/examples/e2e-timeseries/ci/test.py

f769b65

Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com> Signed-off-by: Ricardo Decal <crypdick@users.noreply.github.com>

Update doc/source/ray-overview/examples/e2e-timeseries/ci/test.py

a7ea97b

Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com> Signed-off-by: Ricardo Decal <crypdick@users.noreply.github.com>

Update doc/source/ray-overview/examples/e2e-timeseries/ci/test.py

1833bca

Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com> Signed-off-by: Ricardo Decal <crypdick@users.noreply.github.com>

fix title case

35ade31

Signed-off-by: Ricardo Decal <rdecal@anyscale.com>

crypdick added 5 commits June 2, 2025 15:30

active voice

9682e30

Signed-off-by: Ricardo Decal <rdecal@anyscale.com>

standardize ticks and backticks

4a983ea

Signed-off-by: Ricardo Decal <rdecal@anyscale.com>

active voice

29fff36

Signed-off-by: Ricardo Decal <rdecal@anyscale.com>

active voice

441afae

Signed-off-by: Ricardo Decal <rdecal@anyscale.com>

lint

7d2e95c

Signed-off-by: Ricardo Decal <rdecal@anyscale.com>

angelinalg approved these changes Jun 3, 2025

View reviewed changes

aslonnie approved these changes Jun 3, 2025

View reviewed changes

crypdick and others added 14 commits June 3, 2025 13:08

Update doc/source/ray-overview/examples/e2e-timeseries/e2e_timeseries…

281ad43

…/01-Distributed-Training.ipynb Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com> Signed-off-by: Ricardo Decal <crypdick@users.noreply.github.com>

Update doc/source/ray-overview/examples/e2e-timeseries/e2e_timeseries…

61ae22e

…/01-Distributed-Training.ipynb Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com> Signed-off-by: Ricardo Decal <crypdick@users.noreply.github.com>

Update doc/source/ray-overview/examples/e2e-timeseries/e2e_timeseries…

a67dc4b

…/01-Distributed-Training.ipynb Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com> Signed-off-by: Ricardo Decal <crypdick@users.noreply.github.com>

Update doc/source/ray-overview/examples/e2e-timeseries/e2e_timeseries…

669b6f3

…/01-Distributed-Training.ipynb Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com> Signed-off-by: Ricardo Decal <crypdick@users.noreply.github.com>

Update doc/source/ray-overview/examples/e2e-timeseries/e2e_timeseries…

cd7ee41

…/01-Distributed-Training.ipynb Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com> Signed-off-by: Ricardo Decal <crypdick@users.noreply.github.com>

Update doc/source/ray-overview/examples/e2e-timeseries/e2e_timeseries…

5dcb0e0

…/01-Distributed-Training.ipynb Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com> Signed-off-by: Ricardo Decal <crypdick@users.noreply.github.com>

Update doc/source/ray-overview/examples/e2e-timeseries/e2e_timeseries…

c8709e4

…/01-Distributed-Training.ipynb Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com> Signed-off-by: Ricardo Decal <crypdick@users.noreply.github.com>

Update doc/source/ray-overview/examples/e2e-timeseries/e2e_timeseries…

a7ff669

…/01-Distributed-Training.ipynb Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com> Signed-off-by: Ricardo Decal <crypdick@users.noreply.github.com>

Update doc/source/ray-overview/examples/e2e-timeseries/e2e_timeseries…

1a7823a

…/01-Distributed-Training.ipynb Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com> Signed-off-by: Ricardo Decal <crypdick@users.noreply.github.com>

Update doc/source/ray-overview/examples/e2e-timeseries/e2e_timeseries…

19e8bba

…/01-Distributed-Training.ipynb Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com> Signed-off-by: Ricardo Decal <crypdick@users.noreply.github.com>

Update doc/source/ray-overview/examples/e2e-timeseries/e2e_timeseries…

b98aa72

…/01-Distributed-Training.ipynb Co-authored-by: angelinalg <122562471+angelinalg@users.noreply.github.com> Signed-off-by: Ricardo Decal <crypdick@users.noreply.github.com>

Merge branch 'master' into docs/e2e-ts

8dbe2f5

Signed-off-by: Ricardo Decal <crypdick@users.noreply.github.com>

edit comments for caps, active voice, we prounouns, periods

4eb4d5b

Signed-off-by: Ricardo Decal <rdecal@anyscale.com>

lint

9796e89

Signed-off-by: Ricardo Decal <rdecal@anyscale.com>

Merge branch 'master' into docs/e2e-ts

9d49ade

crypdick mentioned this pull request Jun 4, 2025

[Docs] Adds second notebook to timeseries tutorial #53561

Merged

8 tasks

crypdick requested a review from GokuMohandas June 4, 2025 20:32

GokuMohandas approved these changes Jun 4, 2025

View reviewed changes

angelinalg merged commit 88e50a3 into master Jun 5, 2025
5 checks passed

angelinalg deleted the docs/e2e-ts branch June 5, 2025 19:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Docs] Add e2e timeseries example to examples and release tests#53488

[Docs] Add e2e timeseries example to examples and release tests#53488
angelinalg merged 73 commits intomasterfrom
docs/e2e-ts

crypdick commented Jun 2, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

angelinalg left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

angelinalg commented Jun 4, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

crypdick commented Jun 2, 2025

Why are these changes needed?

Related issue number

Checks

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

angelinalg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

angelinalg commented Jun 4, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants