[Feature Request] Provide instruction for installing and running the optimizer locally

[YorkZ]

Which module is related to your feature request?
Optimizer

Is your feature request related to a problem? Please describe.

I'm more efficient and productive when doing things locally compared with doing remotely. In this case, I would prefer running the optimizer locally on my system instead of having to run it in Google Colab. Being able to run the optimizer on my local system would, to the very least, eliminate from having to upload the exported deck, changing the .apkg file name and the time zone every time. Also, I use Linux, so I guess that setting it up on Linux would be a bit easier.

Describe the solution you'd like

Describe alternatives you've considered

Additional context

[L-M-Sherlock]

You can run it locally through jupyter notebook. I will export the requirements of dependencies.

[YorkZ]

Yep, I had Jupyter Notebook installed, but I suppose there would be quite a few dependencies to install as well.

[YorkZ]

Thank you so much @L-M-Sherlock, you are so fast 👍

[L-M-Sherlock]

You are welcome. And I am looking forward to your reply if you encounter any problems.

[YorkZ]

Just noticed in the requiremets.txt file that all the packages are pinned to specific versions. Do I have to install those exact versions? Are newer versions than those pinned ones OK?

[L-M-Sherlock]

I just used pip freeze > requirements.txt. You can use other versions. But it will make replication hard if you meet some bugs caused by a specific version of dependencies.

[L-M-Sherlock]

Do you run it in local successfully? I think it is better to create a new virtual venv to run it. You can install the dependencies via pip install -r requirements.txt.

[YorkZ]

Yep, I agree that creating a virtualenv dedicated for it might be better. I haven't got the time to do this yet.

[L-M-Sherlock]

Thanks for your testing anyway. And waiting for your good news.