lyst / lightfm

A Python implementation of LightFM, a hybrid recommendation algorithm.
Apache License 2.0
4.77k stars 691 forks source link

Starting on FAQ and Helpful Discussions #582

Closed SimonCW closed 2 years ago

SimonCW commented 3 years ago

This PR might evolve into a useful FAQ section. For the moment, my goal is to keep track of interesting discussions while closing issues and start a discussion on how to best document these discussions to provide value for users and avoid unnecessary questions /issues being created.

I see two types of of useful documentation:

1. FAQ

This should include often asked questions that concern the package directly and are straightforward to answer, e.g.:

2. Useful discussions and strategies (Majority of issues)

This should include often raised question that don't concern the package directly and / or the answer depends a lot on the user's use case. For example:

Here, I would prefer to just link to the relevant Github issues within a pinned "Helpful Discussions" Issue. This way, we would acknowledge that the answer depends on the specific context and that strong trade-offs are involved. It would also be easier for users to propose other topics and useful issues via comments. (For now, I started collecting the issues in an RST document "Helpful Discussions"). What do you think @maciejkula?

SimonCW commented 3 years ago

Hey @maciejkula ,

Realistically, I currently don't have the time to go through more past issues. From my point of view this is a good starting point and ready to merge.

maciejkula commented 2 years ago

Thank you!