Skip to content
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

add encore blog post #33

Merged
merged 7 commits into from
Dec 17, 2016
Merged

add encore blog post #33

merged 7 commits into from
Dec 17, 2016

Conversation

kain88-de
Copy link
Member

Since the next release will be pretty big I thought we could introduce some features already in blog posts. @richardjgowers started this already with mmtf (actually I got the idea from that). This post contains the encore part for the next release.

I reworked it a little bit. It would be nice if @wouterboomsma and @mtiberti could have a look over it.

and ordering as the input list, with each element being the similarity value for
a pair of the input ensembles. Other available measures are the clustering
ensemble similarity measure `encore.ces` and dimensionality reduction ensemble
measure `encore.dres`.
Copy link
Member Author

Choose a reason for hiding this comment

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

It would be nice to have a rule of thumb which method would fit which use-case. Links to papers or the implmentation paper chapter would also be fine.

as
[MDAnalysis.analysis.encore](http://www.mdanalysis.org/mdanalysis/documentation_pages/analysis/encore.html).
It implements a variety of techniques for calculating similarities between
structural ensembles (trajectories), as described in this publication:
Copy link
Member Author

Choose a reason for hiding this comment

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

I think we should do a list of all that encore adds. That would include clustering. Anything else?

Copy link
Member Author

Choose a reason for hiding this comment

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

There is also the PCA. Any other dimension reduction algorithms?

Copy link
Member Author

Choose a reason for hiding this comment

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

The bootstraping is also good to know. But that requires better docs that should explain what it does and where the limitations are.

Copy link
Member

Choose a reason for hiding this comment

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

A nicer link is http://devdocs.mdanalysis.org/documentation_pages/analysis/encore.html

This can be easily changed to the release docs when necessary with s/devdocs/docs/g...

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for the work and the comments - I'm reviewing the blog post. @kain88-de, for the bootstrapping, guess you mean better docs in the docs of bootstrapping itself rather than the blog post?

Copy link
Member Author

Choose a reason for hiding this comment

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

guess you mean better docs in the docs of bootstrapping itself rather than the blog post

How about both? The docs need some work for sure. But I think it should also be introduced here since it is a powerful method to estimate errors when sampling is low (and more sampling can be quite expensive for MD)

>>> print cluster_collection
0 (size:5,centroid:1): array([ 0, 1, 2, 3, 98])
1 (size:5,centroid:6): array([4, 5, 6, 7, 8])
2 (size:7,centroid:12): array([ 9, 10, 11, 12, 13, 14, 15])
Copy link
Member Author

Choose a reason for hiding this comment

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

The blog doesn't really explan the output. It suggests I could infer from it to which trajectory a centroid belongs to.

from the two universes defined above, we can write:

```python
>>> cluster_collection = encore.cluster([u1,u2])
Copy link
Member Author

Choose a reason for hiding this comment

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

What clustering algorithm is chosen? Can I change it?

In addition to standard cluster membership information, the `cluster_collection`
output keep track of the origin of each conformation, so you check how the
different trajectories are represented in each cluster. For further details, see
the documentation of the individual functions within Encore.
Copy link
Member Author

Choose a reason for hiding this comment

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

This should link to the exact docs.

@orbeckst
Copy link
Member

orbeckst commented Dec 7, 2016

Do you want to remove the exensive Encore part of the 0.16.0 blog post PR #26 or do you see this as first introduce features and then show them again in the release blog post?

@orbeckst
Copy link
Member

orbeckst commented Dec 7, 2016

Since the next release will be pretty big I thought we could introduce some features already in blog posts.

And yes, absolutely in favour, see #32 – blog post for the new topology system.

Copy link
Member

@orbeckst orbeckst left a comment

Choose a reason for hiding this comment

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

good idea

as
[MDAnalysis.analysis.encore](http://www.mdanalysis.org/mdanalysis/documentation_pages/analysis/encore.html).
It implements a variety of techniques for calculating similarities between
structural ensembles (trajectories), as described in this publication:
Copy link
Member

Choose a reason for hiding this comment

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

A nicer link is http://devdocs.mdanalysis.org/documentation_pages/analysis/encore.html

This can be easily changed to the release docs when necessary with s/devdocs/docs/g...

@kain88-de
Copy link
Member Author

Do you want to remove the exensive Encore part of the 0.16.0 blog post PR #26 or do you see this as first introduce features and then show them again in the release blog post?

I wanted to cut that from the release blog post. I noticed that the release post is getting very long. So having this small series of blog posts about the big features is nice. In the release post I would just list them again in the beginning and link to the corresponding blog post.

@richardjgowers
Copy link
Member

Yeah splitting the release post into highlights and links to things like this is a good idea imo

Ensemble Similarity [`encore.hes`][hes] measure:

```python
>>> hes_similarities, details = encore.hes([u1, u2])
Copy link
Member Author

Choose a reason for hiding this comment

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

what is actually stored in the details?

@mtiberti
Copy link
Contributor

Hi,
I have reviewed and reworked a bit the blog post, trying to address your suggestions and making it overall better. However it looks like I can't push to the branch:

remote: Permission to MDAnalysis/MDAnalysis.github.io.git denied to mtiberti. fatal: unable to access 'https://github.com/MDAnalysis/MDAnalysis.github.io.git/': The requested URL returned error: 403

how can we do this? I'm using the encore-post branch. Thanks!

@richardjgowers
Copy link
Member

@mtiberti try again now, I think I fixed it ( @orbeckst I added MDAnalysis.github.io write access to the coredevs group)

@mtiberti
Copy link
Contributor

Thanks, it worked now.

@kain88-de
Copy link
Member Author

@mtiberti thanks. That looks a lot better already and gives nice context to the functions. The description for the similiarity measures are also good for the documentation with minimal changes.

@orbeckst
Copy link
Member

@kain88-de and @mtiberti you should sign the post; I think then it is good to go live.

@orbeckst orbeckst mentioned this pull request Dec 15, 2016
6 tasks
@kain88-de kain88-de merged commit a636359 into master Dec 17, 2016
@kain88-de kain88-de deleted the encore-post branch February 15, 2017 21:29
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.

4 participants