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

stem_activations needs documentation #55

Open
bmcfee opened this issue Dec 13, 2016 · 0 comments
Open

stem_activations needs documentation #55

bmcfee opened this issue Dec 13, 2016 · 0 comments
Assignees
Labels
Milestone

Comments

@bmcfee
Copy link
Contributor

bmcfee commented Dec 13, 2016

Two points:

  • mtrack.stem_activations is a list of lists, but the docs say it's an ndarray
  • The shape does not line up to the number of stems; it's off by one. It looks like the first column is reserved for a time index, not activations.

The first point is an easy fix.

The second point is confusing, and it's generally not good style to mix indexing/addressing (ie timestamps) with observation data. (If you do so, it should definitely be documented.) I recommend refactoring this so that the time index is stored separately.

@rabitt rabitt self-assigned this Dec 13, 2016
@rabitt rabitt added the bug label Dec 13, 2016
@rabitt rabitt added this to the v1.3 milestone Dec 13, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants