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

Update readme #36

Merged
merged 1 commit into from
Nov 8, 2024
Merged

Update readme #36

merged 1 commit into from
Nov 8, 2024

Conversation

leonvanbokhorst
Copy link
Owner

@leonvanbokhorst leonvanbokhorst commented Nov 8, 2024

Summary by Sourcery

Update the README to include descriptions of new PoC scripts and summarize recent experimental findings, enhancing documentation on narrative field dynamics and analysis tools.

Documentation:

  • Add detailed descriptions of three proof-of-concept (PoC) scripts: nfs_bias_research.py, bayes_updating.py, and poc_story_vs_narrative.py, highlighting their key features and functionalities.
  • Include a section on the latest experimental results, summarizing key findings related to bias evolution, belief dynamics, and the relationship between stories and narratives.

Copy link
Contributor

sourcery-ai bot commented Nov 8, 2024

Reviewer's Guide by Sourcery

The PR updates the README.md file by adding comprehensive documentation for three proof-of-concept (PoC) implementations and their experimental results. The changes focus on describing new features and findings related to narrative field analysis, Bayesian belief updating, and story-narrative relationships.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added documentation for three new PoC implementations
  • Documented nfs_bias_research.py with features for bias detection and story evolution simulation
  • Documented bayes_updating.py with features for Bayesian belief updating in narratives
  • Documented poc_story_vs_narrative.py with features for analyzing story-narrative relationships
README.md
Added experimental results section
  • Added findings about bias evolution in narrative fields
  • Added results from Bayesian belief updating system
  • Added insights from story-narrative relationship experiments
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@leonvanbokhorst leonvanbokhorst merged commit c4e7682 into main Nov 8, 2024
1 check passed
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @leonvanbokhorst - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟡 Documentation: 1 issue found

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment on lines +182 to +184
- Quantifiable relationships between individual stories and broader narratives
- Measurable impact of narrative modifications
- Consistent patterns in story evolution
Copy link
Contributor

Choose a reason for hiding this comment

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

nitpick (documentation): Add periods at the end of bullet points for consistency

Other bullet points in the document end with periods. Consider adding periods here for consistency.

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.

1 participant