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

[Doc] Documentation with environment descriptions #28

Closed
cbhua opened this issue May 9, 2023 · 2 comments
Closed

[Doc] Documentation with environment descriptions #28

cbhua opened this issue May 9, 2023 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@cbhua
Copy link
Member

cbhua commented May 9, 2023

It would be better to have a document/readme/notebook to describe the environmental problem in detail. Since there are many details for those problems should be clear. For example, can the salesman in the PCTSP visit the depot multi times, should the salesman always come back to the depot for every problem (theoretically should), etc.

This can also include some details in our implementation to help people understand our code better. For example, when we set the trip to be done in the PCTSP, etc.

This is temp in low priority before we finish the repo implementation (I can help during the paper-writing period).

@cbhua cbhua added documentation Improvements or additions to documentation enhancement New feature or request labels May 9, 2023
@cbhua cbhua self-assigned this May 9, 2023
@fedebotu
Copy link
Member

Great idea! This would improve a lot the understanding. I think we could definetely have a description of the environments in the main paper along with more documentation (potentially in the form of rendering + explanation in docs) , let's do this when we complete the experiments and the main paper 👍

@fedebotu fedebotu changed the title [Doc] documents for environment problem description [Doc] Documentation with environment descriptions Jun 9, 2023
@fedebotu
Copy link
Member

Closing now, will be done in docs 👍

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 enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants