question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Verify and document quick methods

See original GitHub issue

Our codebase is primarily class-based, however we do have quick-methods for quickly drawing a visualizer from data without a lot of setup (for the common case). Unfortunately, most of these quick methods are undocumented and are not verified. Before the 1.0 release, it would be good if we could include them in our documentation.

Verifications:

  • Does the quick method return a visualizer? (Most probably return an axes object)
  • Does the quick method have an associated test?
  • Does the quick method support all its parent visualizer arguments?
  • Does the quick method behave as expected?

For documentation:

  • Should we create a new page for the quick methods?
  • Should we add the docstring automodule to the relevant documentation pages?

Other questions:

  • Should quick methods call poof() or finalize() should this be an argument (e.g. poof=True)?
  • Should quick methods do train/test splits? (See ROCAUC and PrecisionRecallCurve)
  • Do the quick methods require other arguments?
  • Is there any reason not to make the quick methods prime time?

Issue Analytics

  • State:closed
  • Created 5 years ago
  • Comments:10 (10 by maintainers)

github_iconTop GitHub Comments

2reactions
bbengfortcommented, Jun 13, 2019

An example of a quick method and a visualizer with detailed doc strings that discuss how best to create meaningful interactions between the two: (I tried to come up with the trickiest quick method that needs to be implemented for discussion)

https://gist.github.com/bbengfort/5d5b211c1cf49f7dac147654e75e5d24

1reaction
Kautumn06commented, Feb 6, 2019

@bbengfort Also, I did add two additional columns to the “Quick Methods” tab to record some additional information I noticed while finishing it. One column to track when a quick method has additional parameters not found in the Visualizer and another that contains notes about when a parameter has different defaults (for instance, balanced_binning_reference has target='Frequency' while BalancedBinningReference has target=None).

The third column I added includes information about when I saw that the difference in parameter names was because of capitalization. For example, freqdist has the parameter N=50, while it is n=50 in FrequencyVisualizer . Most of the additional examples where this occurred involved one having x while the other has X.

So I hope that this is helpful! Please just let me know if you have any questions.

Read more comments on GitHub >

github_iconTop Results From Across the Web

In-depth guide to Document Verification | Nanonets Blog
Document verification is used to check the originality of submitted documents, extract information using OCR software like Nanonets, and confirm ...
Read more >
Verification Methods in Software Verification - GeeksforGeeks
Methods of Verification : 1. Peer Reviews – The very easiest method and informal way of reviewing the documents or the programs/software for ......
Read more >
Top 5 Identity Verification Methods - MicroBilt
Top 5 Identity Verification Methods · Knowledge-based authentication · Two-factor authentication · Credit bureau-based authentication · Database ...
Read more >
Recipient Identity Verification - DocuSign Support
Identity verification methods include: phone authentication (SMS or phone call), knowledge-based ID check, and ID Verification.
Read more >
Systems and methods for document verification
A method for issuing a credential includes scanning in documents (e.g., breeder or ID documents) used to verify the applicant of the ...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found