ctreffe / alfred

Alfred - A library for rapid experiment development
MIT License
10 stars 1 forks source link

Improve test mode documentation #190

Open ctreffe opened 2 years ago

ctreffe commented 2 years ago

Alfred's test mode is very useful when testing experiments both online and locally. For local experiments (e.g., running via PyCharm), there is a neat option to directly launch an expeirment in test mode via the exp.run() method at the end of the script.py:

if __name__ == "__main__":
    exp.run(test=True)

This will make running local experiments in test mode much easier, but I feel this feature is not described prominently in the alfred documentation. We should find a suitable place in the documentation where we can highlight this option.