Skip to content

Update documentation #81

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 35 commits into from
Dec 18, 2020
Merged

Update documentation #81

merged 35 commits into from
Dec 18, 2020

Conversation

TimotheeMathieu
Copy link
Contributor

Update of documentation

  • make a cluster module User-Guide section
  • change examples to separate basic examples from specialised module examples
  • update KMedoids doc: add pam and an example of face recognition article (for which KMedoids is very suitable)

I changed the structure of the doc a bit so if you don't like it, tell me and I will make the changes.

@rth
Copy link
Contributor

rth commented Nov 26, 2020

There are some changes here from #73 so we would need to merge that one first.

But otherwise thanks a lot for improving the documentation, it really needs it.

BTW, the way to avoid such issue with branchs is to always come back master, syncing with upstream and creating a branch from there for other PRs,

git checkout master
git fetch upstream
git rebase upstream/master
git checkout -b new-feature

where upstream was defined as,

git remote add upstream [email protected]:scikit-learn-contrib/scikit-learn-extra.git

(or https://github.com/scikit-learn-contrib/scikit-learn-extra.git if you use HTTP authentication).

@TimotheeMathieu
Copy link
Contributor Author

Ok thanks. Yes I was wondering what's up with all those commits.

Copy link
Contributor

@rth rth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @TimotheeMathieu ! It looks like a nice improvement.

The on case in test_kmedoid_results failed but I see it also did on master. I think we need to fix the random state there.

@rth rth merged commit 4650b04 into scikit-learn-contrib:master Dec 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants