Skip to content

Conversation

@krivard
Copy link

@krivard krivard commented Nov 7, 2025

Overview

What problem does this address?

What did you change in this PR?

  • Add example notebook for SEC 10-k

Testing

How did you make sure this worked? How can a reviewer verify this?

To-do list

  • add other TODO items here if necessary! questions that need to answered, decisions that need to be made, tests that need to be run, etc.
  • Update relevant documentation - like comments, docstrings, README, release notes, etc.
  • Review the PR yourself and call out any questions or issues you have

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@@ -0,0 +1,642 @@
{
Copy link
Member

@e-belfer e-belfer Dec 1, 2025

Choose a reason for hiding this comment

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

In it's final version, we'll want to add some copy up top about what the data is, where to find documentation, and what we're going to do with it.


Reply via ReviewNB

@@ -0,0 +1,642 @@
{
Copy link
Member

@e-belfer e-belfer Dec 1, 2025

Choose a reason for hiding this comment

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

Is central_index_key a field that someone working with the data would be comfortable with? Without more context, it's not clear to me why this is an important first step or what the motivation is here.


Reply via ReviewNB

@@ -0,0 +1,642 @@
{
Copy link
Member

@e-belfer e-belfer Dec 1, 2025

Choose a reason for hiding this comment

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

Does this wind up getting used somewhere? It's not clear to me what the application is at present.


Reply via ReviewNB

@@ -0,0 +1,642 @@
{
Copy link
Member

@e-belfer e-belfer Dec 1, 2025

Choose a reason for hiding this comment

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

This feels more oriented towards characterizing data completion. Narratively, I think it'd make more sense for the notebook to focus on data utilization - e.g., how do I get total generation for a series of nested entities or get a list of all plants owned by one entity and its subsidiaries? You could focus in on one entity for narrative simplicity.


Reply via ReviewNB

@@ -0,0 +1,642 @@
{
Copy link
Member

@e-belfer e-belfer Dec 1, 2025

Choose a reason for hiding this comment

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

Same comment as above - this feels like characterizing data quality, not demonstrating how to best use the data.


Reply via ReviewNB

@@ -0,0 +1,642 @@
{
Copy link
Member

@e-belfer e-belfer Dec 1, 2025

Choose a reason for hiding this comment

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

This is probably the most important part of the notebook and what I'd focus on.


Reply via ReviewNB

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: In progress

Development

Successfully merging this pull request may close these issues.

3 participants