update doc & userguide #463

JulienT01 · 2024-06-26T13:01:27Z

update some doc
and
add on user guide :
Save & Load Agents (In construction)
Save & Load Data (In construction)

Checklist

My code follows the style guideline
To check :
black --check examples rlberry *py
flake8 --select F401,F405,D410,D411,D412 --exclude=rlberry/check_packages.py --per-file-ignores="init.py:F401",
I have commented my code, particularly in hard-to-understand areas,
I have made corresponding changes to the documentation,
I have added tests that prove my fix is effective or that my feature works,
New and existing unit tests pass locally with my changes,
If updated the changelog if necessary,
I have set the label "ready for review" and the checks are all green.

for more information, see https://pre-commit.ci

Co-authored-by: Waris Radji <[email protected]>

for more information, see https://pre-commit.ci

…MLP part of the CNN

for more information, see https://pre-commit.ci

github-actions · 2024-07-08T14:54:14Z

Hello,
The build of the doc failed. Look up the reason here:
https://github.com/rlberry-py/rlberry/actions/workflows/preview.yml

github-actions · 2024-07-09T07:58:40Z

Hello,
The build of the doc failed. Look up the reason here:
https://github.com/rlberry-py/rlberry/actions/workflows/preview.yml

github-actions · 2024-07-09T11:13:35Z

Hello,
The build of the doc succeeded. The documentation preview is available here:
https://rlberry-py.github.io/rlberry/preview_pr

docs/basics/userguide/export_training_data.md

github-actions · 2024-07-09T12:19:41Z

Hello,
The build of the doc succeeded. The documentation preview is available here:
https://rlberry-py.github.io/rlberry/preview_pr

github-actions · 2024-07-09T14:48:15Z

Hello,
The build of the doc succeeded. The documentation preview is available here:
https://rlberry-py.github.io/rlberry/preview_pr

rlberry/manager/evaluation.py

github-actions · 2024-07-10T11:42:20Z

Hello,
The build of the doc succeeded. The documentation preview is available here:
https://rlberry-py.github.io/rlberry/preview_pr

github-actions · 2024-07-10T14:15:10Z

Hello,
The build of the doc succeeded. The documentation preview is available here:
https://rlberry-py.github.io/rlberry/preview_pr

github-actions · 2024-07-11T12:33:41Z

Hello,
The build of the doc succeeded. The documentation preview is available here:
https://rlberry-py.github.io/rlberry/preview_pr

for more information, see https://pre-commit.ci

github-actions · 2024-07-11T13:20:24Z

Hello,
The build of the doc succeeded. The documentation preview is available here:
https://rlberry-py.github.io/rlberry/preview_pr

rlberry/manager/evaluation.py

github-actions · 2024-07-11T14:40:52Z

Hello,
The build of the doc succeeded. The documentation preview is available here:
https://rlberry-py.github.io/rlberry/preview_pr

rlberry/manager/evaluation.py

github-actions · 2024-07-12T07:26:42Z

Hello,
The build of the doc succeeded. The documentation preview is available here:
https://rlberry-py.github.io/rlberry/preview_pr

brahimdriss and others added 30 commits July 24, 2023 14:46

Updated eval() and policy() docstring of agent

ba63c17

Update docstring for eval_agents in manager

13f5a16

update docstring on agent

b184d3c

update docstring on agentTorch

2507148

[pre-commit.ci] auto fixes from pre-commit.com hooks

89d43cd

for more information, see https://pre-commit.ci

Removed redundancy in docstring

5af9400

typo correction

a2f8cc1

Co-authored-by: Waris Radji <[email protected]>

typo correction

263c178

Co-authored-by: Waris Radji <[email protected]>

update docstring folowing first reviews

cacaeed

Merge 'origin/main' into sprint_doc

21742a9

[pre-commit.ci] auto fixes from pre-commit.com hooks

33b9316

for more information, see https://pre-commit.ci

typos and add link to the docstring

d7733fb

[pre-commit.ci] auto fixes from pre-commit.com hooks

16950c9

for more information, see https://pre-commit.ci

update name in docstring following PR350: rlberry-py#350

0d9a824

update kwargs docstring

2f9f8db

update kwargs and docstring

9fa00a1

update kwargs docstring

bfab6d9

[pre-commit.ci] auto fixes from pre-commit.com hooks

9cf5d0f

for more information, see https://pre-commit.ci

typo correction

638c8c1

ctns_action previously unused inside the kwargs, is now given to the …

6b21ca6

…MLP part of the CNN

[pre-commit.ci] auto fixes from pre-commit.com hooks

abf0582

for more information, see https://pre-commit.ci

docstring : gym.Env -> gymnasium.Env

3fd2423

docstring : update and kwargs

ab725a3

[pre-commit.ci] auto fixes from pre-commit.com hooks

65f64f9

for more information, see https://pre-commit.ci

remove old warning (tests on P3.10 are ok)

76fe4bf

add the "requirement.txt" in the beginner dev guide

f0a51cb

typo correction

357ba1d

update names following PR350(part2): rlberry-py#350

399c359

[pre-commit.ci] auto fixes from pre-commit.com hooks

52e107f

for more information, see https://pre-commit.ci

update changelog

adced89

update changelog + typos

4232be4

add information about the default writer

45412bb

update read_writer_data code (last update didn't work)

1708080

TimotheeMathieu reviewed Jul 9, 2024

View reviewed changes

docs/basics/userguide/export_training_data.md Outdated Show resolved Hide resolved

docs/basics/userguide/export_training_data.md Outdated Show resolved Hide resolved

docs/basics/userguide/export_training_data.md Outdated Show resolved Hide resolved

typo from code review

7e8b818

update read_writer_date to correct bug with 'str' datasource

1e24120

group one function

338023c

TimotheeMathieu reviewed Jul 10, 2024

View reviewed changes

rlberry/manager/evaluation.py Outdated Show resolved Hide resolved

rlberry/manager/evaluation.py Outdated Show resolved Hide resolved

code review update + do the sort on "last modification date"

b73292c

add tests for read_writer_data

ed89461

update read_writer_date to correct bug with 'str' datasource

689fe7a

JulienT01 and others added 3 commits July 11, 2024 15:09

update path separator for multi-plateform

2a8ca1c

Merge branch 'main' into sprint_doc

d7f2a5d

[pre-commit.ci] auto fixes from pre-commit.com hooks

86444a5

for more information, see https://pre-commit.ci

TimotheeMathieu reviewed Jul 11, 2024

View reviewed changes

rlberry/manager/evaluation.py Show resolved Hide resolved

add test to improve the cover

66f38ee

TimotheeMathieu reviewed Jul 11, 2024

View reviewed changes

rlberry/manager/evaluation.py Outdated Show resolved Hide resolved

rlberry/manager/evaluation.py Outdated Show resolved Hide resolved

update from code review

6243290

JulienT01 merged commit 9a2b8c6 into rlberry-py:main Jul 12, 2024
12 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

update doc & userguide #463

update doc & userguide #463

JulienT01 commented Jun 26, 2024 •

edited

Loading

github-actions bot commented Jul 8, 2024

github-actions bot commented Jul 9, 2024

github-actions bot commented Jul 9, 2024

github-actions bot commented Jul 9, 2024

github-actions bot commented Jul 9, 2024

github-actions bot commented Jul 10, 2024

github-actions bot commented Jul 10, 2024

github-actions bot commented Jul 11, 2024

github-actions bot commented Jul 11, 2024

github-actions bot commented Jul 11, 2024

github-actions bot commented Jul 12, 2024

update doc & userguide #463

update doc & userguide #463

Conversation

JulienT01 commented Jun 26, 2024 • edited Loading

Checklist

github-actions bot commented Jul 8, 2024

github-actions bot commented Jul 9, 2024

github-actions bot commented Jul 9, 2024

github-actions bot commented Jul 9, 2024

github-actions bot commented Jul 9, 2024

github-actions bot commented Jul 10, 2024

github-actions bot commented Jul 10, 2024

github-actions bot commented Jul 11, 2024

github-actions bot commented Jul 11, 2024

github-actions bot commented Jul 11, 2024

github-actions bot commented Jul 12, 2024

JulienT01 commented Jun 26, 2024 •

edited

Loading