Skip to content

Enhance documentation and examples for OCEAN#36

Merged
AwaKhouna merged 1 commit intomainfrom
fix-docs
Apr 7, 2026
Merged

Enhance documentation and examples for OCEAN#36
AwaKhouna merged 1 commit intomainfrom
fix-docs

Conversation

@AwaKhouna
Copy link
Copy Markdown
Collaborator

  • Updated README.md to include new backends for counterfactual search.
  • Added init.py for documentation extension.
  • Improved ocean_docs_stubs.py with additional class stubs.
  • Expanded API documentation for ocean.maxsat, ocean.mip, and ocean.typing modules.
  • Revised custom dataset example to provide a detailed walkthrough.
  • Clarified explainer guide regarding cleanup behavior and added objective value retrieval.
  • Updated installation instructions to specify Python version requirement.
  • Enhanced overview documentation for cleaner explanation of explainer usage.
  • Modified examples to improve clarity and functionality, including better handling of counterfactuals.
  • Added detailed docstrings to explainer methods for better understanding of functionality.

- Updated README.md to include new backends for counterfactual search.
- Added __init__.py for documentation extension.
- Improved ocean_docs_stubs.py with additional class stubs.
- Expanded API documentation for ocean.maxsat, ocean.mip, and ocean.typing modules.
- Revised custom dataset example to provide a detailed walkthrough.
- Clarified explainer guide regarding cleanup behavior and added objective value retrieval.
- Updated installation instructions to specify Python version requirement.
- Enhanced overview documentation for cleaner explanation of explainer usage.
- Modified examples to improve clarity and functionality, including better handling of counterfactuals.
- Added detailed docstrings to explainer methods for better understanding of functionality.
@AwaKhouna AwaKhouna merged commit 032df3e into main Apr 7, 2026
8 checks passed
@AwaKhouna AwaKhouna deleted the fix-docs branch April 7, 2026 21:46
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