Algos visibility #1542
Algos visibility #1542
Conversation
miguelgfierro
requested review from
anargyri,
gramhagen,
loomlike,
wutaomsft and
yueguoguo
as code owners
|
How about including both deep dive and quick start for each algorithm in the table? |
Makes sense |
|
I'm going to put here some options: Option 1 (Original):
Option 2 (add extra column):
Option 3 (remove environment column and add it in description):
Option 3.5 (remove environment column and add it in description):
Option 4 (option 3 with reordered columns):
Option 5 (variation of 4 removing the word "Python" to save space):
|
I would vote for option 3, as our eyes are naturally drawn to either ends of the page. I am not sure how important it is to provide the environment information to users. As a first time user, I didn't find the environment info that much helpful because I would try out the algorithm regardless of the environment anyways if it is interesting 😄. |
There was a problem hiding this comment.
My preference (modified option 3) 😄
Option 3.5 (remove environment column and add it in description):
| Algorithm | Type | Description | Example |
|---|---|---|---|
| Alternating Least Squares (ALS) | Collaborative Filtering | Matrix factorization algorithm for explicit or implicit feedback in large datasets, optimized by Spark MLLib for scalability and distributed computing capability | Quick start / Deep dive |
|
I would vote for option 2 or option 3.5. I think each algorithm we have maps 1-1 to an environment, so both notebooks use the same environment. You can specify it in a separate column or omit it. I tend towards including the env info, because e.g. some people want to try the repo on a machine without GPU and it is convenient to see which methods may be slower because of this. |
|
@laserprec I added column 3.5 in the list. @yueguoguo @loomlike @gramhagen @wutaomsft any preference? |
|
ok, I'll implement 3.5 as suggested by @anargyri and @laserprec |
|
@anargyri @laserprec, please feel free to review again. If you find a typo or small thing that need to be change, as in other times, feel free to change it directly |
Codecov Report
@@ Coverage Diff @@
## staging #1542 +/- ##
===========================================
- Coverage 62.36% 62.13% -0.24%
===========================================
Files 85 84 -1
Lines 8503 8437 -66
===========================================
- Hits 5303 5242 -61
+ Misses 3200 3195 -5
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
|
@laserprec @anargyri when you are available, can you please review again? |
I double checked all the links again. Looks good! |
Description
I was talking with a colleague that is interested in graph recommenders. I realized that it is not straightforward for people that don't know the repo to know that sometimes there are quickstart notebooks and sometimes deep dive notebooks.
Not sure what is the best way to give visibility to all the content. Maybe we could consider adding the deep dive into the main readme? Other option could make a comment in the deep dive, referencing the quickstart, and viceversa, in the markdown of the notebook.
@anargyri what do you think?
Related Issues
Checklist:
staging branchand not tomain branch.