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

Outdated documentation #203

Closed
idk2me opened this issue Jan 15, 2025 · 4 comments · Fixed by #204
Closed

Outdated documentation #203

idk2me opened this issue Jan 15, 2025 · 4 comments · Fixed by #204

Comments

@idk2me
Copy link

idk2me commented Jan 15, 2025

The section on building MDPs is either outdated or is missing some parts. I recognize that it is an explanation of 01-building-mdps.py (this one works). What's missing is states_labeling definition and this results in NameError: name 'state_labeling' is not defined. Did you mean: 'choice_labeling'?. According to the example, to fix this in the documentation nr_states = 13 needs to be declared and after defining/building transition_matrix state_labeling needs to be defined and labels added.

@linusheck
Copy link

Thank you for opening the issue! Indeed, it seems like the state_labeling definition is missing.

If you want to build a small MDP using Python, you could also try out our new more accessible Python library, stormvogel. You can find docs on how to build an MDP there. But this is not as fast as the SparseMatrixBuilder.

@volkm
Copy link
Contributor

volkm commented Jan 16, 2025

The documentation tries to find a balance between completeness and conciseness. For MDPs we opted to not again explain how to build the state labeling, because it is already explained in the DTMC case. #204 will add links to the relevant documentation such that it should be a bit clearer.
Note that the notebook itself also contains the state labeling, it is just hidden for the documentation. So if you start the notebook you should also see the complete code.

@idk2me
Copy link
Author

idk2me commented Jan 16, 2025

Note that the notebook itself also contains the state labeling, it is just hidden for the documentation. So if you start the notebook you should also see the complete code.

This would be fine, but I find myself getting timed out when starting your binder notebooks session or receiving too many connections error. To clarify, this is not always the case, but still majority of the time this is what happens, at least within the last week.

Image

@volkm
Copy link
Contributor

volkm commented Jan 16, 2025

The notebooks use the external binder service which has limited computation resources. You can however also run the Jupter notebooks locally.

Install Jupyter notebook with

pip install jupyterlab==4.1.8

Run it with

jupyter lab

In the commandline, there should be a local url http://127.0.0.1:8888/lab?token=... which you can open in a web browser. From there on you can open the notebooks. Our notebooks are located under the path doc/source/doc/.

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 a pull request may close this issue.

3 participants