Release/v1.0.0 sdk realignment#6
Merged
Merged
Conversation
Replaces the stale whiteboxai/whiteboxai.io (single "x") branding and src/ layout with the fixed, canonical whiteboxxai/whiteboxxai.com content from the whitebox-xai-azure monorepo's sdk/ directory: - Flat whiteboxxai/ package layout (was src/whiteboxai/); dropped the legacy setup.py in favor of pyproject.toml as the single build config. - Fixed an import-time crash affecting anyone without PyTorch/TensorFlow installed, corrected ModelMonitor's resource API calls, added structured exception metadata, and added buffering/context-manager/ drift-report/alert convenience methods (see CHANGELOG.md [1.0.0] for the full list). - Preserved and rebranded (rather than discarded) this repo's existing release scaffolding: CHANGELOG.md (added [1.0.0] and a reconstructed [0.2.1] entry), the mkdocs documentation site, and the tests/ unit+integration structure -- now populated with the repaired test suite (168 passed, 2 skipped locally, one for a missing sklearn install, one for a not-yet-implemented metrics resource). - Updated test.yml for the new layout and .env.example/MANIFEST.in for accuracy. publish.yml needs no changes (package-name-agnostic, OIDC trusted publishing). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
dewitt4
added
documentation
Fixes Code Quality Checks (black --check, isort --check-only), which was never run against this content before the previous commit. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This reverts commit 3f20fcd.
Removes ~70 flake8 findings so Code Quality Checks passes fully: unused imports (F401), unused local variables (F841), f-strings without placeholders (F541), a redefined-but-unused pipeline import (F811) in the transformers integration, and two E402 import-order findings in tensorflow.py (noqa'd — the imports genuinely must follow the TORCH_AVAILABLE-style try/except guard). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
… build The guide's embedded example content linked to files from the main platform repo's structure (DEVELOPMENT.md, CONTRIBUTING.md, a proposed docs/ layout) that don't exist in this repo, failing `mkdocs build --strict`. De-linked them to plain text since they're illustrative references, not real navigable docs here. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces the first stable, production release of the SDK, with a major rebranding and several breaking changes, new features, and fixes. The SDK is now named
whiteboxxai(double "x"), and all references, import paths, and configuration variables have been updated accordingly. The codebase structure has been simplified, new features have been added to theModelMonitor, and various documentation and example code have been updated to match the new branding and API. This release also fixes several integration and documentation issues and adds support for Python 3.12.Rebranding and Breaking Changes
whiteboxai/whiteboxai-sdktowhiteboxxai/whitebox-xai-sdk(double "x"), updating all import paths, install commands, and environment variables (e.g.,EXPLAINAI_*→WHITEBOXXAI_*). The API base URL is changed towhiteboxxai.com. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17] [18] [19]src/whiteboxai/to a flatwhiteboxxai/layout at the repository root, removedsetup.py, and now usepyproject.tomlas the single build configuration. [1] [2]New Features and Improvements
ModelMonitor, new convenience methods, and improved error handling with structured metadata in SDK exceptions. [1] [2]Documentation and Example Updates
README.md, code samples, and guides to use the new package name, environment variables, and install commands. Fixed incorrect class names, import paths, and added documentation for new features. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15]LICENSEfile matching the declared MIT license.Bug Fixes
Miscellaneous
This release contains several breaking changes—users must update their import paths, environment variables, and install commands to migrate.