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

Fix tips and add jupyter lab to the environment #75

Conversation

eberrigan
Copy link
Collaborator

@eberrigan eberrigan commented Apr 11, 2024

  • Black formatting is used throughout
  • Fix tests for tips

Summary by CodeRabbit

  • Refactor
    • Simplified control flow in the tip handling feature by removing an unnecessary return statement.
  • Tests
    • Added comments for clarity, asserted the shape and content of tips, verified the y-coordinates of the tips, and updated the test case to reflect changes in tip calculation logic in the test_get_tip_ys_no_tip function.
  • Chores
    • Updated the version of the codecov/codecov-action from v3 to v4 in the CI workflow for uploading coverage reports.
  • Chores
    • Updated the package version from "0.0.7" to "0.0.8" in the sleap_roots/__init__.py file.

Copy link
Contributor

coderabbitai bot commented Apr 11, 2024

Walkthrough

The changes in this update encompass enhancing testing clarity, updating package versions, and improving workflow configurations. From detailed testing improvements to version updates, these modifications aim to refine processes and maintain consistency.

Changes

File Path Change Summary
tests/test_tips.py Added comments for clarity, asserted shape and content of tips, verified y-coordinates of the tips, and updated the test case to reflect changes in tip calculation logic.
.github/workflows/ci.yml Updated codecov/codecov-action from version v3 to v4 for coverage report uploads.
sleap_roots/__init__.py Updated package version from "0.0.7" to "0.0.8".

🐇✨
Changes dance in lines of code,
Versions shift, tests now bode.
With packages new and tests so clear,
The rabbit hops without a fear.
Code sings a tune, joy is near! 🌟


Recent Review Details

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between bdf6ceb and 0ce5b1c.
Files selected for processing (1)
  • .github/workflows/ci.yml (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/ci.yml

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Comment on lines 139 to 141
Jupyter notebooks are located in this repo at `sleap-roots/notebooks`.

To use them, activate your conda environment which includes JupyterLab (recommended):
Copy link
Contributor

Choose a reason for hiding this comment

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

The instructions for using Jupyter notebooks have been removed. This could potentially confuse new users who might still need these instructions to understand how to use the notebooks provided in the repository.

+ To use the Jupyter notebooks, activate your conda environment which includes JupyterLab (recommended):
+ ```
+ conda activate sleap-roots
+ ```
+ Clone this repository if you haven't already:
+ ```
+ git clone https://github.com/talmolab/sleap-roots.git && cd sleap-roots
+ ```
+ Then you can change directories to the location of the notebooks, and open Jupyter Lab:
+ ```
+ cd notebooks
+ jupyter lab
+ ```

@eberrigan eberrigan changed the title Fix formatting after some changes that were pushed to main Fix tips and add jupyter lab to the environment Apr 12, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Actionable comments outside the diff hunks (1)
sleap_roots/__init__.py (1)

Line range hint 14-22: Several imports are flagged as unused. Consider removing them or adding them to __all__ if they are intended for public API use.

- import sleap_roots.trait_pipelines
- from sleap_roots.trait_pipelines import (
-     DicotPipeline,
-     TraitDef,
-     YoungerMonocotPipeline,
-     OlderMonocotPipeline,
-     MultipleDicotPipeline,
- )
- from sleap_roots.series import Series, find_all_series

Copy link

codecov bot commented Apr 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.92%. Comparing base (4091d71) to head (0ce5b1c).
Report is 9 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #75      +/-   ##
==========================================
+ Coverage   74.90%   74.92%   +0.01%     
==========================================
  Files          13       13              
  Lines        1307     1312       +5     
==========================================
+ Hits          979      983       +4     
- Misses        328      329       +1     

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

@eberrigan eberrigan merged commit f8baa7b into main Apr 12, 2024
5 checks passed
@eberrigan eberrigan deleted the elizabeth/Fix-tip-pt-y-coordinate-return-shape-and-make-jupyter-lab-part-of-environment branch April 12, 2024 01:21
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