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

Passing Python Kwargs to Godot Envrionment #206

Merged
merged 9 commits into from
Oct 21, 2024

Conversation

GianiStatie
Copy link
Collaborator

@GianiStatie GianiStatie commented Oct 15, 2024

As Ivan wonderfully put it into words:

custom arguments for launching the Godot env without calling a function, e.g. to set a different difficulty or do anything else with the env from Godot

@GianiStatie GianiStatie changed the title Kwargs to godot Passing Python Kwargs to Godot Envrionment Oct 16, 2024
@GianiStatie
Copy link
Collaborator Author

This time it should work. I tested the flows locally before the commit 😅

Copy link
Owner

@edbeeching edbeeching left a comment

Choose a reason for hiding this comment

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

Looks great. Do you have an example env / code snippet of how a user would parse the args on the Godot side?

@GianiStatie
Copy link
Collaborator Author

GianiStatie commented Oct 17, 2024

I’m working on one, though it’s not yet published.

I want to use the arguments to change the starting level such that people can skip those that the agent is too good on.

My plan is to make a tutorial on how to use the environment and the extra arguments.

Idk if I can make the parsing generic enough to push some changes on the plugin tho.

Copy link
Collaborator

@Ivan-267 Ivan-267 left a comment

Choose a reason for hiding this comment

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

It might be enough (for start) to have a short doc in the docs folder that explains the basic way to use the arguments (e.g. how to modify the sb3 training example to send a custom argument when training starts).

It should be enough for users to know how to pass the arguments during training, and how the argument can be accessed in Godot (this is generic, so you could even point to the Godot docs for argument parsing).

Different users would definitely have different use cases for this so it might not need to be overly abstracted initially (although we can later build on it as needed to add specific functionalities for specific use cases).

@GianiStatie
Copy link
Collaborator Author

GianiStatie commented Oct 17, 2024

Oh right, sure, I get it now. I’ll make the change tomorrow soon👍

@GianiStatie
Copy link
Collaborator Author

I've added some info, hope it makes sense. I'm a bit rusty when it comes to writing docs as I don't exactly know who's the target audience 😅

Copy link
Owner

@edbeeching edbeeching left a comment

Choose a reason for hiding this comment

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

Thanks for this change. LGTM. @GianiStatie would you like to be added as a contributor so making PRs is easier etc?

@GianiStatie
Copy link
Collaborator Author

hey @edbeeching 👋 sure, tho I can't promise to keep it at this pase 😆

@GianiStatie GianiStatie merged commit 179d07e into edbeeching:main Oct 21, 2024
13 checks passed
@GianiStatie GianiStatie deleted the kwargs-to-godot branch October 21, 2024 09:57
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.

3 participants