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

Preliminary rdflib resource for ISMI CIDOC-CRM time spans #117

Draft
wants to merge 13 commits into
base: develop
Choose a base branch
from

Conversation

rlskoeser
Copy link
Member

@rlskoeser rlskoeser commented Mar 18, 2025

@robcast I have preliminary work on an rdf resource class to map to your ISMI dates (related to #17). I called it cidoc_ crm but wonder if it should be made more explicit since it is particular to your implementation. (Hopefully in future we could generalize and make it more reusable.)

I put it under converters but I'm not sure it can work the same as the other converters, since I think parsing and serializing both require the context of an rdf graph. I have only implemented and tested one case for the to_undate method - I know you started on this in a notebook in another branch. I think ideally it should use the calendar-aware date parsing and then use the other fields to check/validate the conversion, but that probably requires merging in one of my other branches first... 😅

LMK what you think about the approach, names, conversion, etc.

@rlskoeser rlskoeser requested a review from robcast March 18, 2025 14:29
Copy link
Contributor

coderabbitai bot commented Mar 18, 2025

Important

Review skipped

Draft detected.

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.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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 generate docstrings to generate docstrings for this 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.

@property
def label(self):
# for ISMI records, label is under the crm identifier/appelation
# other examples have it directly under the time span as RDFS.label
Copy link
Contributor

@robcast robcast Mar 18, 2025

Choose a reason for hiding this comment

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

The idea is that the Time-Span is the processable Gregorian xsd:Date while the appellation represents the date in its original calendar therefore the appellation has the calendar type and its label has the date rendered in e.g. Hijri (the Time-Span label would rather have the date rendered in Gregorian)

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks for clarifying, I sort of got what you were doing here but not fully.

How would this ideally map to an undate? Would it be two different undate objects? (they should sort the same). Or for this case would you ignore/bypass calendar conversion?

@robcast
Copy link
Contributor

robcast commented Mar 19, 2025

I think the pattern using the Appellation to represent the calendar is pretty generalizable. The problem is that there are no standard-URIs for the mini-ontology of calendar types and accuracy types. I currently use the ismi project namespace but to be really reusable the URI namespaces should be configurable. Maybe we could start with the ismi version and call the file and the class "cidoc_crm_ismidate" and generalize later? Or we leave it at "cidoc_crm" and add the configurability sooner?

@rlskoeser
Copy link
Member Author

@robcast happy to follow whichever direction makes more sense to you here - I think either one works, and I don't have a clear sense of which would be easier. Would it be useful to create and publish our own namespaces for use with undate, or is it better to make it extensible so projects can use their own? Whichever direction we take, it would be great to talk through the approach and identify what classes and behaviors we want.

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