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

Create MATRX tutorial(s) and fix existing tutorials #313

Open
23 tasks
thaije opened this issue Nov 26, 2021 · 4 comments
Open
23 tasks

Create MATRX tutorial(s) and fix existing tutorials #313

thaije opened this issue Nov 26, 2021 · 4 comments
Assignees
Labels
request A request for a new feature

Comments

@thaije
Copy link
Collaborator

thaije commented Nov 26, 2021

Is your feature request related to a problem? Please describe.
I want tutorials and help on how MATRX works, for beginners and more advanced users.

Describe the solution you would like
A basic tutorial based on the BW4T task (see #284) introducing:

  • Basic concepts of MATRX (agents, case, builder, objects, gridworld, etc.)
  • How agents work with the state and actions
  • How action duration works
  • How the state works
  • How to send messages
  • How traversability of objects works
  • How objects and the update() function work
  • How the context menu works
  • Doing a task with multiple people

Include a FAQ with some specific questions:

  • Where to find more documentation (the API docs, other tutorials, etc)
  • Where to find example usecases (example of BW4T, Ruben experiment, Emma experiment, triage experiment)
  • Can I use MATRX for 3d environments?
  • How fast is MATRX?
  • I get error X, how do I solve this?

More advanced tutorial(s):

  • How to create custom messages
  • How to create custom actions
  • How to create custom (human) agents
  • How to customize the context menu
  • How to create a custom frontend

Using MATRX for experiments

Describe alternatives you have considered
Videos that show how it works, but that requires us making these tutorials anyway and is more work because of recording and editing etc.

Additional context
The most requested improvement on all of MATRX.

@thaije thaije added the request A request for a new feature label Nov 26, 2021
@thaije thaije self-assigned this Nov 26, 2021
@thaije
Copy link
Collaborator Author

thaije commented Nov 26, 2021

@jwaa did I miss anything?

@thaije thaije changed the title Descriptive title Create MATRX tutorial(s) Nov 26, 2021
@jwaa
Copy link
Member

jwaa commented Dec 2, 2021

@jwaa did I miss anything?

I think you have the most important bits. Regarding the FAQ, we already have one. So either add to the questions there or add new ones.

You can also add the tutorials we already have to this list and check them already. So this issue can be used to track them all not only the new ones.

Finally, I still think that a tutorial where much of these separate things are combined might be useful. Especially since you cannot really do some of these things without already having a task inplace.

Ideas for such tasks we once had were;

  • Tetris
  • Overcooked
  • Tag
  • Maze navigation
  • Red/Blue teaming
  • BW4T
  • ...

@thaije thaije changed the title Create MATRX tutorial(s) Create MATRX tutorial(s) and fix existing tutorials Sep 7, 2022
@thaije
Copy link
Collaborator Author

thaije commented Sep 7, 2022

The default tutorial: https://matrx-software.com/docs/tutorials/basics/creating-your-first-world/
Does not work because an error is given when there is no (human) agent added.

Also some of the tutorials do not work because of refactoring, such as this one, that doesn't work as the agent parameter is renamed to agent_brain. So these tutorials should be checked as well.

@jwaa
Copy link
Member

jwaa commented Sep 12, 2022

The default tutorial: https://matrx-software.com/docs/tutorials/basics/creating-your-first-world/ Does not work because an error is given when there is no (human) agent added.

Thanks for pointing that out! Does it fail right from the first code block or later?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
request A request for a new feature
Projects
None yet
Development

No branches or pull requests

2 participants