Docu fix: result = trainer.run()

[carlocagnetta]

Issue Description

In the provided code examples, it appears that the training function is not being used properly. Specifically, in both cases cited by the code-line links, the variable named result is being assigned a trainer class which is never used.

Proposed Solution

To address this issue, I suggest changing the class instance from result to trainer and assign the ouput of its function run() to the variable result; using it as follows:

# Before
result = OnpolicyTrainer()
print(result)

# After
trainer = OnpolicyTrainer()
result = trainer.run()
print(result)

or more efficiently:

result = OnpolicyTrainer().run()
print(result)

Affected Code Lines

tianshou/docs/02_notebooks/L6_Trainer.ipynb

Lines 193 to 204 in ea48cc2

	"result = OnpolicyTrainer(\n",
	" policy=policy,\n",
	" train_collector=train_collector,\n",
	" test_collector=test_collector,\n",
	" max_epoch=10,\n",
	" step_per_epoch=1,\n",
	" repeat_per_collect=1,\n",
	" episode_per_test=10,\n",
	" step_per_collect=2000,\n",
	" batch_size=512,\n",
	")\n",
	"print(result)"

tianshou/docs/02_notebooks/L7_Experiment.ipynb

Lines 241 to 252 in ea48cc2

	"result = OnpolicyTrainer(\n",
	" policy=policy,\n",
	" train_collector=train_collector,\n",
	" test_collector=test_collector,\n",
	" max_epoch=10,\n",
	" step_per_epoch=50000,\n",
	" repeat_per_collect=10,\n",
	" episode_per_test=10,\n",
	" batch_size=256,\n",
	" step_per_collect=2000,\n",
	" stop_fn=lambda mean_reward: mean_reward >= 195,\n",
	")"

[carlocagnetta]

@MischaPanch @opcode81 This is the issue we discussed

[carlocagnetta]

resolved by #1009