search

cage-challenge / cage-challenge-4

The TTCP CAGE Challenges are a series of public challenges instigated to foster the development of autonomous cyber defensive agents. This CAGE Challenge 4 (CC4) returns to a defence industry enterprise environment, and introduces a Multi-Agent Reinforcement Learning (MARL) scenario.
https://cage-challenge.github.io/cage-challenge-4/
Other
41 stars 10 forks source link

vanishingly minor: example outputs are pprint not print? #5

Closed bodacea closed 9 months ago

bodacea commented 9 months ago

really not an issue, but just a note for anyone following the code examples slavishly: the example outputs in https://github.com/cage-challenge/cage-challenge-4/blob/main/documentation/docs/pages/tutorials/01_Getting_Started/2_Getting_Started.md look like they've been prettyprinted (or are from a notebook? I think that might prettyprint). Could suggest using "from pprint import pprint; pprint(thing)" to get a cleaner format, or could just ignore this as not important.

rykrr commented 9 months ago

Hi there!

from rich import print was used to produce the output, but it was ultimately not included as it would add a dependency. That being said, you have raised a good point: this could throw off someone following the documentation since the format is different, even if the content were to be identical. I will fix this (and the number of agents listed on the homepage) once I have a spare minute.

Thank you!