feature: Allow str arguments in Trainer.profiler

[ddrevicky]

What does this PR do?

Fixes #3330

• Allows str parameters for profiler arg in Trainer
• Deprecates bool parameters for profiler arg in Trainer
• Removes bool parameters for profiler from examples in docs
• Adds tests checking correct profilers are returned for str arguments

# equivalent options
# CLI: --profiler true (deprecated) or --profiler simple
trainer = Trainer(profiler=True)        # deprecated
trainer = Trainer(profiler=SimpleProfiler())
trainer = Trainer(profiler="simple")

# equivalent options
# CLI: --profiler advanced
trainer = Trainer(profiler=AdvancedProfiler())
trainer = Trainer(profiler="advanced")

Before submitting

• Was this discussed/approved via a Github issue? (no need for typos and docs improvements)
• Did you read the contributor guideline, Pull Request section?
• Did you make sure your PR does only one thing, instead of bundling different changes together? Otherwise, we ask you to create a separate PR for every change.
• Did you make sure to update the documentation with your changes?
• Did you write any new necessary tests?
• Did you verify new and existing tests pass locally with your changes?
• If you made a notable change (that affects users), did you update the CHANGELOG?

[pep8speaks]

Hello @ddrevicky! Thanks for updating this PR.

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2020-10-27 10:08:35 UTC

[mergify]

This pull request is now in conflict... :(

[ddrevicky]

I've added deprecation of bool argument for the profiler like @justusschock requested. I'm not sure I've done all the steps for deprecation correctly, especially:

• version in which removal occurs
• deprecation tests in test_deprecated.py
• I removed examples of passing bool to profiler from docs, is that right?

Let me know if there's anything that needs correction. The failing checks seem to be unrelated to the PR.

[codecov]

Codecov Report

Merging #3656 into master will increase coverage by 1%.
The diff coverage is 100%.

@@           Coverage Diff           @@
##           master   #3656    +/-   ##
=======================================
+ Coverage      91%     93%    +1%     
=======================================
  Files         111     111            
  Lines        8272    8096   -176     
=======================================
- Hits         7550    7506    -44     
+ Misses        722     590   -132     

[ydcjeff]

It shall be better to add warning of bool here too

[rohitgr7]

Just some suggestions. Btw LGTM. Nice work!