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

updated ismi sample data for development branch #104

Merged
merged 6 commits into from
Nov 22, 2024

Conversation

robcast
Copy link
Contributor

@robcast robcast commented Nov 18, 2024

update ISMI sample data for development branch.

Copy link
Contributor

coderabbitai bot commented Nov 18, 2024

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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

@kypso-io kypso-io bot left a comment

Choose a reason for hiding this comment

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

📋 Review Summary

  • Number of files reviewed: 2
  • Number of comments: 0
  • Number of suggestions: 0

📚 File changes

File path File changes
examples/use-cases/ismi/README.md Updated the ISMI sample data structure and file references.
examples/use-cases/ismi/data/ismi-crm-date-samples.ttl Updated ISMI sample data for the development branch.
Ignored comments

examples/use-cases/ismi/README.md

  • refactor_suggestion: The previous description of the old ISMI database and its structure has been removed. Ensure that the new structure is clearly explained and that any necessary context about the transition from the old to the new database is provided elsewhere in the documentation if needed.

  • refactor_suggestion: The new structure of the ISMI database is introduced without a transition explanation. Consider adding a brief note about the significance of this change and how it improves upon the previous structure for clarity.

  • refactor_suggestion: The sample file reference has changed from a JSON format to a TTL format. Ensure that users are aware of this change and provide guidance on how to work with the new file format if necessary.

examples/use-cases/ismi/data/ismi-crm-date-samples.ttl

  • refactor_suggestion: Consider using a consistent format for the date labels across different calendar types to improve clarity and maintainability. For example, the Islamic dates use a specific format while Gregorian and Julian dates use a different one. Standardizing these formats can help in future data processing and understanding.

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

Copy link
Member

@rlskoeser rlskoeser left a comment

Choose a reason for hiding this comment

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

The updated example data and description looks great, and I think that part could be merged.

If you want to back out the notebook and move that to a different branch we could merge this portion - up to you.

@robcast
Copy link
Contributor Author

robcast commented Nov 22, 2024

I took out the notebook and moved it to an extra branch "ismi-sample-notebook". Do you want to review @rlskoeser or should I just merge?

Copy link
Member

@rlskoeser rlskoeser left a comment

Choose a reason for hiding this comment

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

Great! Thanks for updating & documenting.

We plan to extract as much as possible of this data in the migration to the new RDF database with a CIDOC-CRM-based data model.

A sample file with dates of each type can be found in `data/ismi-om4-date-samples.json`
A sample file with dates of each type can be found in `data/ismi-crm-date-samples.ttl`
Copy link
Member

Choose a reason for hiding this comment

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

We could turn this into a markdown relative link at some point, but this is fine for now. I think we're going to need to restructure the examples and notebooks anyway now that we have a few more of them.

@rlskoeser rlskoeser merged commit 57f8f66 into develop Nov 22, 2024
6 of 7 checks passed
@rlskoeser rlskoeser deleted the 17-ismi-sample-data branch November 22, 2024 13:50
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.

2 participants