Update docs for multishard and predicates

[justin13601]

Summary by CodeRabbit

• Documentation
  • Simplified the documentation title to "ACES Documentation" for improved clarity.
  • Removed version details from the documentation configuration to focus on the project name.
  • Streamlined console output by excluding version information during configuration loading.
  • Added a new "Updates" section in the README for recent enhancements and features.
  • Enhanced clarity and usability of configuration documentation, including new parameters for data handling.
  • Updated URLs and references throughout various documentation files for consistency and accessibility.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes involve updates to the documentation configuration across multiple files. Key modifications include commenting out versioning details in conf.py, simplifying the documentation title, and refining content in the README and configuration documents. Additional parameters have been introduced in configuration files, enhancing usability, while URLs and references have been updated for clarity and accuracy.

Changes

File	Change Summary
docs/source/conf.py	Commented out release and version variables; modified html_title to "ACES Documentation"; updated print statement to exclude version information.
README.md	Added "Updates" section; refined installation and usage instructions; clarified predicates and logging details; updated method signatures and variable definitions.
docs/source/configuration.md	Added other_cols field to configuration documentation.
docs/source/index.md	Updated links and examples related to machine learning tasks; modified phrasing for clarity.
docs/source/notebooks/examples.ipynb	Updated URLs for data and configs; added bash command example; refined markdown content.
docs/source/notebooks/predicates.ipynb	Updated sample predicates DataFrame URL and issue reference; clarified derived predicate example.
docs/source/notebooks/tutorial.ipynb	Modified URLs for sample configs and data to point to the main branch.
docs/source/usage.md	Enhanced clarity in Hydra configuration documentation; added new parameters with definitions.
src/aces/config.py	Modified load method to collect labels from the windows dictionary.
src/aces/configs/init.py	Added required parameters root and shard for sharded data; introduced optional predicates_path.
src/aces/configs/_aces.yaml	Added required fields root and shard under data for sharded data; included optional predicates_path.

Possibly related PRs

• Update docs for multishard and predicates #126: The changes in this PR directly relate to the main PR as both involve modifications to the docs/source/conf.py file, specifically commenting out the release and version variables and altering the html_title, indicating a shared focus on simplifying documentation and reducing emphasis on versioning.

Poem

🐰 In the garden of docs, we've made a change,
The title now simpler, no need to rearrange.
With versions now quiet, they hop out of sight,
Clarity blooms in the soft morning light.
So let’s celebrate, with a joyful cheer,
For the changes we've made, bring us all near! 🌼

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d2bd0ee and 1e5dde4.

Files selected for processing (1)

• docs/source/conf.py (3 hunks)

Files skipped from review due to trivial changes (1)

• docs/source/conf.py

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Files with missing lines	Coverage Δ
src/aces/config.py	97.62% <100.00%> (+0.04%)	⬆️

... and 1 file with indirect coverage changes

[justin13601]

This is for #120 120, still WIP

[justin13601]

Closes #120
Closes #131