HanClinto · July 1, 2021 21:41
diff --git a/gen_nle_docs.py b/gen_nle_docs.py
 import aicrowd_gym
 import gym
 import nle
 import numpy as np
 import collections
 from nle import nethack as nh

 def getPrintableChar(a):
    non_printable_chars = ['NULL', 'START_OF_HEADING', 'START_OF_TEXT', 'END_OF_TEXT', 'END_OF_TRANSMISSION', 'ENQUIRY', 'ACKNOWLEDGE', 'BELL', 'BACKSPACE', 'HORIZONTAL_TAB', 'LINE_FEED', 'VERTICAL_TAB', 'FORM_FEED', 'CARRIAGE_RETURN', 'SHIFT_OUT', 'SHIFT_IN', 'DATA_LINK_ESCAPE', 'DEVICE_CONTROL_1', 'DEVICE_CONTROL_2', 'DEVICE_CONTROL_3', 'DEVICE_CONTROL_4', 'NEGATIVE_ACKNOWLEDGE', 'SYNCHRONOUS_IDLE', 'END_OF_TRANSMISSION_BLOCK', 'CANCEL', 'END_OF_MEDIUM', 'SUBSTITUTE', 'ESCAPE', 'FILE_SEPARATOR', 'GROUP_SEPARATOR', 'RECORD_SEPARATOR', 'UNIT_SEPARATOR']
    if a < 32:
        return f'`{non_printable_chars[a]}`'
    if a == 96: # Markdown escape sequence for backtick
        return "'`` ` ``'"
    return f'\'`{chr(a)}`\''

 def myprint(d):
    for k, v in d.items():
        print (k, type(v))
        if isinstance(v, dict):
            myprint(v)
        else:
            print(k, ":", v)

 def printObservationSpace(d):
    for k, v in d.items():
        # print (k, type(v))
        if isinstance(v, collections.OrderedDict):
            printObservationSpace(v)
        elif isinstance(v, gym.spaces.box.Box):
            print(f"| `['{k}']` | {v.shape} | {v.low.min()} | {v.high.max()} | {v.dtype} |")
            # print(k, f'[v.shape]', ":", v)

 env = aicrowd_gym.make("NetHackChallenge-v0") 

 print("*_NOTE: Auto-generated by `gen_nle_docs.py`_*")

 print("")
 print("## Actions: `env._actions`")
 print("### Actions sorted by action index:")
 print("")
 print ("| Index | Action | ASCII | Character |")
 print ("| ----- | ------ | ----- | --------- |")
 sorted = []
 for i, a in enumerate(env._actions):
    print("|", i, "|", a, "|", getPrintableChar(a), "|", int(a), "|")
 #    print(f'    * [{i}]:', a, f'{getPrintableChar(a)} ({a}):')
 #    print(f'    * [{i}]: `', a, '`')
 #    print(f'        * ASCII: {getPrintableChar(a)} ({a}):')
    sorted.append(a)

 sorted.sort()

 print("")
 print("### Actions sorted by ASCII character:")
 print ("#### Actions With Non-Printable Characters:")
 print ("")
 print ("| ASCII | Character | Action |")
 print ("| ----- | --------- | ------ |")
 for a in sorted:
    if a < 32:
        print("|", getPrintableChar(a), "|", int(a), "|", a, "|")

 print ("")
 print ("#### Actions With Printable Characters:")
 print ("")
 print ("| ASCII | Character | Action |")
 print ("| ----- | --------- | ------ |")
 for a in sorted:
    if a >= 32:
        print("|", getPrintableChar(a), "|", int(a), "|", a, "|")

 #    print(f'    * {getPrintableChar(a)} ({a}): `', a, '`')

 observation_space = env.observation_space
 print("")
 print("## Observation space: `env.observation_space`")
 print("NOTE: For more details, please see [nle_docs_ObservationSpace.md](nle_docs_ObservationSpace.md)")
 print("")
 print ("| Key | Shape | Min | Max | DType |")
 print ("| --- | ----- | --- | --- | ----- |")

 printObservationSpace(observation_space.__dict__)

 print("")
 print("## Environment object: `env`")
 print("### Everything:")
 print("")
 print("```")
 myprint(env.__dict__)
 print("```")
diff --git a/gen_nle_docs_glyphs.py b/gen_nle_docs_glyphs.py
 from nle import nethack as nh

 obj_classes = {getattr(nh, x): x for x in dir(nh) if x.endswith('_CLASS')}
 glyph_classes = sorted((getattr(nh, x), x) 
                       for x in dir(nh) if x.endswith('_OFF'))

 print("*_NOTE: Auto-generated by `gen_nle_docs_glyphs.py`_*")
 print("")

 print("## Glyph classes")
 print("")
 print(glyph_classes)

 print("")
 print("## Object classes")
 print("")
 print(obj_classes)


 print("")
 print("## Detailed Glyph Table")
 print("")
 print ('| Glyph | Class | Description | (Optional) Subclass')
 print ('| ----- | ----- | -------- | ----------- |')
 last_cls = ""
 for i in range(nh.MAX_GLYPH):
    desc = ''
    if glyph_classes and i == glyph_classes[0][0]:
        cls = glyph_classes.pop(0)[1].replace("_OFF","")
    
    if (cls != "GLYPH_MON" and cls != "GLYPH_OBJ" and cls == last_cls):
        pass
    else:
        if nh.glyph_is_monster(i):
            desc = f'"{nh.permonst(nh.glyph_to_mon(i)).mname}" | '
        
        if nh.glyph_is_normal_object(i):
            obj = nh.objclass(nh.glyph_to_obj(i))
            appearance = nh.OBJ_DESCR(obj) or nh.OBJ_NAME(obj) 
            oclass = ord(obj.oc_class)
            desc = f'"{appearance}" | {obj_classes[oclass]}'

        print(f'| {i} | {cls} | {desc} |'  )

        if (cls != "GLYPH_MON" and cls != "GLYPH_OBJ"):
            print (f'| ... | ... | --More-- |  |')


    last_cls = cls

diff --git a/nle_docs.md b/nle_docs.md
	import aicrowd_gym
	import gym
	import nle
	import numpy as np
	import collections
	from nle import nethack as nh

	def getPrintableChar(a):
	non_printable_chars = ['NULL', 'START_OF_HEADING', 'START_OF_TEXT', 'END_OF_TEXT', 'END_OF_TRANSMISSION', 'ENQUIRY', 'ACKNOWLEDGE', 'BELL', 'BACKSPACE', 'HORIZONTAL_TAB', 'LINE_FEED', 'VERTICAL_TAB', 'FORM_FEED', 'CARRIAGE_RETURN', 'SHIFT_OUT', 'SHIFT_IN', 'DATA_LINK_ESCAPE', 'DEVICE_CONTROL_1', 'DEVICE_CONTROL_2', 'DEVICE_CONTROL_3', 'DEVICE_CONTROL_4', 'NEGATIVE_ACKNOWLEDGE', 'SYNCHRONOUS_IDLE', 'END_OF_TRANSMISSION_BLOCK', 'CANCEL', 'END_OF_MEDIUM', 'SUBSTITUTE', 'ESCAPE', 'FILE_SEPARATOR', 'GROUP_SEPARATOR', 'RECORD_SEPARATOR', 'UNIT_SEPARATOR']
	if a < 32:
	return f'`{non_printable_chars[a]}`'
	if a == 96: # Markdown escape sequence for backtick
	return "'`` ` ``'"
	return f'\'`{chr(a)}`\''

	def myprint(d):
	for k, v in d.items():
	print (k, type(v))
	if isinstance(v, dict):
	myprint(v)
	else:
	print(k, ":", v)

	def printObservationSpace(d):
	for k, v in d.items():
	# print (k, type(v))
	if isinstance(v, collections.OrderedDict):
	printObservationSpace(v)
	elif isinstance(v, gym.spaces.box.Box):
	print(f"\| `['{k}']` \| {v.shape} \| {v.low.min()} \| {v.high.max()} \| {v.dtype} \|")
	# print(k, f'[v.shape]', ":", v)

	env = aicrowd_gym.make("NetHackChallenge-v0")

	print("_NOTE: Auto-generated by `gen_nle_docs.py`_")

	print("")
	print("## Actions: `env._actions`")
	print("### Actions sorted by action index:")
	print("")
	print ("\| Index \| Action \| ASCII \| Character \|")
	print ("\| ----- \| ------ \| ----- \| --------- \|")
	sorted = []
	for i, a in enumerate(env._actions):
	print("\|", i, "\|", a, "\|", getPrintableChar(a), "\|", int(a), "\|")
	# print(f' * [{i}]:', a, f'{getPrintableChar(a)} ({a}):')
	# print(f' * [{i}]: `', a, '`')
	# print(f' * ASCII: {getPrintableChar(a)} ({a}):')
	sorted.append(a)

	sorted.sort()

	print("")
	print("### Actions sorted by ASCII character:")
	print ("#### Actions With Non-Printable Characters:")
	print ("")
	print ("\| ASCII \| Character \| Action \|")
	print ("\| ----- \| --------- \| ------ \|")
	for a in sorted:
	if a < 32:
	print("\|", getPrintableChar(a), "\|", int(a), "\|", a, "\|")

	print ("")
	print ("#### Actions With Printable Characters:")
	print ("")
	print ("\| ASCII \| Character \| Action \|")
	print ("\| ----- \| --------- \| ------ \|")
	for a in sorted:
	if a >= 32:
	print("\|", getPrintableChar(a), "\|", int(a), "\|", a, "\|")

	# print(f' * {getPrintableChar(a)} ({a}): `', a, '`')

	observation_space = env.observation_space
	print("")
	print("## Observation space: `env.observation_space`")
	print("NOTE: For more details, please see [nle_docs_ObservationSpace.md](nle_docs_ObservationSpace.md)")
	print("")
	print ("\| Key \| Shape \| Min \| Max \| DType \|")
	print ("\| --- \| ----- \| --- \| --- \| ----- \|")

	printObservationSpace(observation_space.__dict__)

	print("")
	print("## Environment object: `env`")
	print("### Everything:")
	print("")
	print("```")
	myprint(env.__dict__)
	print("```")
	from nle import nethack as nh

	obj_classes = {getattr(nh, x): x for x in dir(nh) if x.endswith('_CLASS')}
	glyph_classes = sorted((getattr(nh, x), x)
	for x in dir(nh) if x.endswith('_OFF'))

	print("_NOTE: Auto-generated by `gen_nle_docs_glyphs.py`_")
	print("")

	print("## Glyph classes")
	print("")
	print(glyph_classes)

	print("")
	print("## Object classes")
	print("")
	print(obj_classes)


	print("")
	print("## Detailed Glyph Table")
	print("")
	print ('\| Glyph \| Class \| Description \| (Optional) Subclass')
	print ('\| ----- \| ----- \| -------- \| ----------- \|')
	last_cls = ""
	for i in range(nh.MAX_GLYPH):
	desc = ''
	if glyph_classes and i == glyph_classes[0][0]:
	cls = glyph_classes.pop(0)[1].replace("_OFF","")

	if (cls != "GLYPH_MON" and cls != "GLYPH_OBJ" and cls == last_cls):
	pass
	else:
	if nh.glyph_is_monster(i):
	desc = f'"{nh.permonst(nh.glyph_to_mon(i)).mname}" \| '

	if nh.glyph_is_normal_object(i):
	obj = nh.objclass(nh.glyph_to_obj(i))
	appearance = nh.OBJ_DESCR(obj) or nh.OBJ_NAME(obj)
	oclass = ord(obj.oc_class)
	desc = f'"{appearance}" \| {obj_classes[oclass]}'

	print(f'\| {i} \| {cls} \| {desc} \|' )

	if (cls != "GLYPH_MON" and cls != "GLYPH_OBJ"):
	print (f'\| ... \| ... \| --More-- \| \|')


	last_cls = cls
Key	Shape	Min	Max	DType	Description
`'blstats'`	[25]	-2147483648	2147483647	int64	Array of player stats, generally found on the bottom line of the screen.
`'chars'`	[21, 79]	0	255	uint8	Characters used in the map view of the screen (see also `glyphs` and `tty_chars`)
`'colors'`	[21, 79]	0	15	uint8	Colors of the characters on the screen.
`'glyphs'`	[21, 79]	0	5976	int16	Glyphs of each space on the map. Much more detailed than the simple `chars` array. This is what you want to be using.
`'inv_glyphs'`	[55]	0	5976	int16	Glyphs of each item in your inventory.
`'inv_letters'`	[55]	0	127	uint8	Letters assigned to each item in your inventory, used for accessing those items (such as what you want to throw / drop / equip / quaff / eat / etc)
`'inv_oclasses'`	[55]	0	18	uint8	The category that each inventory item belongs to.
`'inv_strs'`	[55, 80]	0	255	uint8	String description of each item in your inventory.
`'message'`	[256]	0	255	uint8	Text of the top-line message.
`'misc'`	[3]	-2147483648	2147483647	int32	Special array that indicates the state of the user interface, corresponding to three boolean values: Am I in a yes/no question? Am I writing the input to a line? Am I waiting for a space? See below for more info.
`'specials'`	[21, 79]	0	255	uint8	Array that holds special information for each glyph on the map, indicating some extended information. See below for more info.
`'tty_chars'`	[24, 80]	0	255	uint8	Similar to `chars`, these are the characters used in the TTY map view of the screen (see also `glyphs` and `chars`). Again, there is overlap here with `glyphs` and this array provides less information. Better to use `glyphs`.
`'tty_colors'`	[24, 80]	0	31	int8	Similar to `colors`, these are the colors used by the `tty_chars` display.
`'tty_cursor'`	[2]	0	255	uint8	X/Y coordinates of the cursor in the terminal interface.
Index	Name	Description
0	x coordinate	Current player X coordinate on the grid. 1 <= ux <= cols
1	y coordinate	Current player Y coordinate on the grid. 0 <= uy < rows
2	strength_percentage	??
3	strength	Character Str attribute, relates to damage dealt, carrying capacity, etc.
4	dexterity	Character Dex attribute, relates to to-hit percentage, throwing accuracy, etc.
5	constitution	Character Con attribute, relates to max HP, healing rate, etc.
6	intelligence	Character Int attribute, relates to some classes casting spells, learning spells, etc.
7	wisdom	Character Wis attribute, relates to some classes casting spells, recharging mana, etc.
8	charisma	Character Cha attribute, primarily relates to the cost of items in shops, but affects some other encounters as well.
9	score	The player's current score as judged by Nethack (not necessarily the reward function of NLE).
10	hitpoints	Current hitpoints
11	max_hitpoints	Maximum hitpoints
12	depth	?Max depth achieved? Or current dungeon level?
13	gold	How much gold is in your main inventory (not counting anything held in bags)
14	energy	Amount of energy / mana available for casting spells
15	max_energy	Maximum amount of energy / mana available for casting spells
16	armor_class	The player's resistance to damage. Lower is better. Generally improved by wearing equipment, though intrinsic AC can be gained via divine Protection.
17	monster_level	?The level of your current monster shape (if polymorphed different from your starting race)?
18	experience_level	Your current experience level (from 1-30)
19	experience_points	The amount of experience you have. Generally increased by fighting monsters, though some non-fighting conducts will need to use other means.
20	time	The current turn counter.
21	hunger state	Player's current state of hunger.
22	carrying_capacity	?Current state of encumbrance?
23	dungeon number	?Which dungeon branch you are currently in (main, gnomish mines, Sokoban, etc)?
24	level number	?Either current dungeon level, or current depth within the current dungeon branch (such as Sokoban: 2?
Index	Name	Description
0	yn_question	Am I in a yes or no question? (Like after "pray")
1	getline	Am I writing the input to a line? (Like making a wish)
2	xwaitforspace	Am I waiting for a space? (Like when -More- is shown, or after "inventory")
Flag	Bit	Description
MG_CORPSE	0x01	Corpse
MG_INVIS	0x02	Do we know an invisible monster is here? (generally represented by a '`?`' character)
MG_DETECT	0x04	Do we detect a monster here? (such as from a Ring of Warning)
MG_PET	0x08	Is this a pet of ours?
MG_RIDDEN	0x10	Is this a ridden creature?
MG_STATUE	0x20	Is this a statue?
MG_OBJPILE	0x40	Is there a stack of more than one object here?
MG_BW_LAVA	0x80	Is this lava? Helps us distinguish water from lava.
Index	Action	ASCII	Character
0	CompassDirection.N	'`k`'	107
1	CompassDirection.E	'`l`'	108
2	CompassDirection.S	'`j`'	106
3	CompassDirection.W	'`h`'	104
4	CompassDirection.NE	'`u`'	117
5	CompassDirection.SE	'`n`'	110
6	CompassDirection.SW	'`b`'	98
7	CompassDirection.NW	'`y`'	121
8	CompassDirectionLonger.N	'`K`'	75
9	CompassDirectionLonger.E	'`L`'	76
10	CompassDirectionLonger.S	'`J`'	74
11	CompassDirectionLonger.W	'`H`'	72
12	CompassDirectionLonger.NE	'`U`'	85
13	CompassDirectionLonger.SE	'`N`'	78
14	CompassDirectionLonger.SW	'`B`'	66
15	CompassDirectionLonger.NW	'`Y`'	89
16	MiscDirection.UP	'`<`'	60
17	MiscDirection.DOWN	'`>`'	62
18	MiscDirection.WAIT	'`.`'	46
19	MiscAction.MORE	`CARRIAGE_RETURN`	13
20	Command.EXTCMD	'`#`'	35
21	Command.EXTLIST	'`¿`'	191
22	Command.ADJUST	'`á`'	225
23	Command.ANNOTATE	'`Á`'	193
24	Command.APPLY	'`a`'	97
25	Command.ATTRIBUTES	`CANCEL`	24
26	Command.AUTOPICKUP	'`@`'	64
27	Command.CALL	'`C`'	67
28	Command.CAST	'`Z`'	90
29	Command.CHAT	'`ã`'	227
30	Command.CLOSE	'`c`'	99
31	Command.CONDUCT	'`Ã`'	195
32	Command.DIP	'`ä`'	228
33	Command.DROP	'`d`'	100
34	Command.DROPTYPE	'`D`'	68
35	Command.EAT	'`e`'	101
36	Command.ESC	`ESCAPE`	27
37	Command.ENGRAVE	'`E`'	69
38	Command.ENHANCE	'`å`'	229
39	Command.FIRE	'`f`'	102
40	Command.FIGHT	'`F`'	70
41	Command.FORCE	'`æ`'	230
42	Command.GLANCE	'`;`'	59
43	Command.HISTORY	'`V`'	86
44	Command.INVENTORY	'`i`'	105
45	Command.INVENTTYPE	'`I`'	73
46	Command.INVOKE	'`é`'	233
47	Command.JUMP	'`ê`'	234
48	Command.KICK	`END_OF_TRANSMISSION`	4
49	Command.KNOWN	'`\`'	92
50	Command.KNOWNCLASS	'`'	96
51	Command.LOOK	'`:`'	58
52	Command.LOOT	'`ì`'	236
53	Command.MONSTER	'`í`'	237
54	Command.MOVE	'`m`'	109
55	Command.MOVEFAR	'`M`'	77
56	Command.OFFER	'`ï`'	239
57	Command.OPEN	'`o`'	111
58	Command.OPTIONS	'`O`'	79
59	Command.OVERVIEW	`SHIFT_IN`	15
60	Command.PAY	'`p`'	112
61	Command.PICKUP	'`,`'	44
62	Command.PRAY	'`ð`'	240
63	Command.PUTON	'`P`'	80
64	Command.QUAFF	'`q`'	113
65	Command.QUIT	'`ñ`'	241
66	Command.QUIVER	'`Q`'	81
67	Command.READ	'`r`'	114
68	Command.REDRAW	`DEVICE_CONTROL_2`	18
69	Command.REMOVE	'`R`'	82
70	Command.RIDE	'`Ò`'	210
71	Command.RUB	'`ò`'	242
72	Command.RUSH	'`g`'	103
73	Command.RUSH2	'`G`'	71
74	Command.SAVE	'`S`'	83
75	Command.SEARCH	'`s`'	115
76	Command.SEEALL	'`*`'	42
77	Command.SEETRAP	'`^`'	94
78	Command.SIT	'`ó`'	243
79	Command.SWAP	'`x`'	120
80	Command.TAKEOFF	'`T`'	84
81	Command.TAKEOFFALL	'`A`'	65
82	Command.TELEPORT	`DEVICE_CONTROL_4`	20
83	Command.THROW	'`t`'	116
84	Command.TIP	'`Ô`'	212
85	Command.TRAVEL	'`_`'	95
86	Command.TURN	'`ô`'	244
87	Command.TWOWEAPON	'`X`'	88
88	Command.UNTRAP	'`õ`'	245
89	Command.VERSION	'`ö`'	246
90	Command.VERSIONSHORT	'`v`'	118
91	Command.WEAR	'`W`'	87
92	Command.WHATDOES	'`&`'	38
93	Command.WHATIS	'`/`'	47
94	Command.WIELD	'`w`'	119
95	Command.WIPE	'`÷`'	247
96	Command.ZAP	'`z`'	122
97	TextCharacters.PLUS	'`+`'	43
98	TextCharacters.MINUS	'`-`'	45
99	TextCharacters.SPACE	' '	32
100	TextCharacters.APOS	'`'`'	39
101	TextCharacters.QUOTE	'`"`'	34
102	TextCharacters.NUM_0	'`0`'	48
103	TextCharacters.NUM_1	'`1`'	49
104	TextCharacters.NUM_2	'`2`'	50
105	TextCharacters.NUM_3	'`3`'	51
106	TextCharacters.NUM_4	'`4`'	52
107	TextCharacters.NUM_5	'`5`'	53
108	TextCharacters.NUM_6	'`6`'	54
109	TextCharacters.NUM_7	'`7`'	55
110	TextCharacters.NUM_8	'`8`'	56
111	TextCharacters.NUM_9	'`9`'	57
112	TextCharacters.DOLLAR	'`$`'	36