Skip to content

Add custom estimator docs#225

Open
jthorton wants to merge 2 commits into
mainfrom
estimator-docs
Open

Add custom estimator docs#225
jthorton wants to merge 2 commits into
mainfrom
estimator-docs

Conversation

@jthorton

@jthorton jthorton commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

Description

Provide a brief description of the PR's purpose here.
Drafted by me and cleaned with GPT5
Fixes #210

Todos

Notable points that this PR has either accomplished or will accomplish.

  • TODO 1

Questions

  • Question1

Checklist

  • Added a news entry for new features, bug fixes, or other user facing changes.

Status

  • Ready to go

Tips

  • Comment "pre-commit.ci autofix" to have pre-commit.ci atomically format your PR.
    Since this will create a commit, it is best to make this comment when you are finished with your work.

@review-notebook-app

Copy link
Copy Markdown

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@codecov

codecov Bot commented Jun 17, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.53%. Comparing base (c91f57d) to head (73e8e55).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #225   +/-   ##
=======================================
  Coverage   97.53%   97.53%           
=======================================
  Files          22       22           
  Lines        2470     2470           
=======================================
  Hits         2409     2409           
  Misses         61       61           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@@ -0,0 +1,404 @@
{

@IAlibay IAlibay Jun 22, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

[nit] After the second sentence, it might be good to put something like "Here we demonstrate how you can do this." It's really obvious, but it might help with reading comprehension.


Reply via ReviewNB

@@ -0,0 +1,404 @@
{

@IAlibay IAlibay Jun 22, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

"any experimental measurments" - typo


Reply via ReviewNB

@@ -0,0 +1,404 @@
{

@IAlibay IAlibay Jun 22, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Line #72.                    sign = 1.0 if graph.has_edge(label_a, label_b) else -1.0

Can you have direction in the edge if you have an undirected graph (i.e. you're using nx.Graph above)?


Reply via ReviewNB

@IAlibay IAlibay left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I'm going to very lightly block on the graph direction bit, just because it's a bit confusing to readers. Everything else looks great though!

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.

Add new estimator API tutorial

2 participants