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

Visualizer Audit #669

Closed
2 of 5 tasks
bbengfort opened this issue Dec 10, 2018 · 0 comments · Fixed by #948
Closed
2 of 5 tasks

Visualizer Audit #669

bbengfort opened this issue Dec 10, 2018 · 0 comments · Fixed by #948
Assignees
Labels
priority: high should be done before next release type: task non-code related task
Milestone

Comments

@bbengfort
Copy link
Member

bbengfort commented Dec 10, 2018

In preparation for Yellowbrick v1.0 we would like to conduct an audit of the state of Yellowbrick visualizers (both documented and undocumented).

With the idea in mind that the overall purpose of this audit is to get a comprehensive sense of where our visualizer hierarchy is most and least healthy, we should:

  • Audit the quick methods, to support the follow-on task Verify and document quick methods #600 (maybe add Cooks Distance?)
  • Ensure code conventions are defined in docs
  • Build the updated uml diagram of the classes
  • Examine for "hot spots" -- this will be places in our class hierarchy where there are attributes/methods missing or implemented in a non-standard way; we'll use the columns of the audit spreadsheet as a de facto health check
  • open up follow-on issues to fix things that need to be fixed (i.e. in future milestones). This should ideally on a per-visualizer (e.g. Radviz) or per-visualizer family (e.g. regression visualizers) basis, since this will be easier to distribute across contributors than a task that says, for instance, "update all the classes to make sure fit returns self"

The ongoing audit can be viewed on this google sheets document.

Related issues:

@DistrictDataLabs/team-oz-maintainers feel free to give suggestions on the things we should be looking for!

@bbengfort bbengfort added type: task non-code related task priority: high should be done before next release labels Dec 10, 2018
@bbengfort bbengfort added this to the v1.0 milestone Feb 6, 2019
@rebeccabilbro rebeccabilbro self-assigned this Jul 23, 2019
@rebeccabilbro rebeccabilbro mentioned this issue Jul 29, 2019
9 tasks
@bbengfort bbengfort mentioned this issue Aug 1, 2019
10 tasks
@rebeccabilbro rebeccabilbro mentioned this issue Aug 15, 2019
9 tasks
bbengfort pushed a commit that referenced this issue Aug 15, 2019
This PR is towards #669 and #456 and #600 and #509 but focused on the 
`yellowbrick.features` module and completes the work started in #945. 

- Performed general linting and applied black formatting to the files & 
   made code header updates.
- Updated quick methods to return the visualizer rather than the axes
- Update the docs to reflect the move of RFECV and FeatureImportances 
   from features to model_selection module

Closes #669
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: high should be done before next release type: task non-code related task
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants