matrx-software / matrx

Human-Agent Teaming Rapid Experimentation Software
https://www.matrx-software.com
MIT License
10 stars 3 forks source link

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

Open thaije opened 2 years ago

thaije commented 2 years ago

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:

Include a FAQ with some specific questions:

More advanced tutorial(s):

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 commented 2 years ago

@jwaa did I miss anything?

jwaa commented 2 years ago

@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;

thaije commented 2 years ago

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 commented 2 years ago

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?