This version:

1. Includes changes to allow cometx download to download remote assets.

Full Changelog: 2.5.0...2.5.1

What's Changed

• Copy in parallel by @dsblank in #12

Full Changelog: 2.4.1...2.5.0

Release Notes for CometX v2.4.1

Overview

CometX has been updated with significant improvements in functionality, security, testing, and documentation. This release includes major enhancements to the CLI interface, improved error handling, comprehensive testing infrastructure, and better support for different deployment scenarios.

Major New Features

Enhanced CLI Interface

• New command-line authentication: Added --api-key and --url-override parameters for direct authentication without requiring environment variables or config files
• Improved path handling: Better support for Windows paths with backslash handling in copy operations
• Enhanced error handling: More robust error messages and validation

WandB Integration Improvements

• Enhanced security: Added protections for username access in WandB downloads
• Better error handling: Improved handling of missing or malformed WandB metadata
• Robust data extraction: More reliable extraction of system information and program details

🔧 Technical Improvements

Code Quality & Maintenance

• Import reorganization: Updated import statements to match changes in comet_ml library structure
• Path normalization: Improved handling of file paths across different operating systems
• Code refactoring: Cleaner, more maintainable code structure

Testing Infrastructure

• Comprehensive test suite: Added extensive unit and integration tests
• Test organization: Moved unit tests to dedicated unit/ directory
• CI/CD pipeline: Added GitHub Actions workflow for automated testing
• Test coverage: Added pytest configuration and coverage reporting

Development Tools

• Code formatting: Added Black, isort, and flake8 configuration
• Type checking: Added mypy configuration for better type safety
• Documentation: Enhanced docstring formatting with pydocstyle
• Pre-commit hooks: Added pre-commit configuration for code quality

📦 Dependencies & Packaging

Updated Dependencies

• Core dependencies: Updated comet_ml to version 3.49.1 or higher
• New requirements: Added comprehensive requirements.txt with all necessary dependencies
• Development tools: Added testing and development dependencies
• Optional features: Enhanced extras_require with additional packages for full functionality

Package Management

• Modern packaging: Added pyproject.toml for modern Python packaging standards
• Better dependency management: Improved setup.py with more comprehensive dependency specifications

🛠️ Admin Features

Chargeback Report Enhancement

• Optional date parameter: Made YEAR-MONTH parameter optional in chargeback reports
• Backward compatibility: Maintains support for existing usage patterns
• Improved flexibility: Can now generate reports without specifying a specific month

📚 Documentation Updates

Enhanced Documentation

• Migration guide: Comprehensive updates to MIGRATIONS.md with detailed examples
• README improvements: Updated installation and usage instructions
• Command reference: Added detailed command-line reference documentation
• Examples: More comprehensive examples for different use cases

New Documentation Files

• Admin guide: Added README-ADMIN.md for administrative features
• Pre-commit setup: Added PRE_COMMIT_SETUP.md for development setup
• Migration examples: Enhanced migration documentation with practical examples

🔒 Security & Stability

WandB Security Improvements

• Username protection: Added safeguards against username access issues
• Metadata validation: Better handling of malformed WandB metadata
• Error resilience: More robust error handling in download operations

General Stability

• Import fixes: Resolved import issues with comet_ml library changes
• Path handling: Improved cross-platform path handling
• Error messages: More informative error messages and validation

🧪 Testing & Quality Assurance

New Test Infrastructure

• Unit tests: Added comprehensive unit tests for utilities and panel functions
• Integration tests: Added integration tests for download functionality
• Test models: Added test model files for validation
• Automated testing: GitHub Actions workflow for continuous integration

Code Quality

• Linting: Added flake8 configuration for code style enforcement
• Formatting: Black and isort for consistent code formatting
• Type checking: MyPy configuration for static type analysis

📋 Migration Notes

Breaking Changes

• Import changes: Some internal imports have been reorganized to match comet_ml library updates
• CLI authentication: New command-line authentication options available

Deprecation Warnings

• Chargeback reports: YEAR-MONTH parameter is now optional but still supported for backward compatibility

🚀 Installation

To upgrade to the latest version:

pip install cometx --upgrade

🔗 Links

• Documentation: See MIGRATIONS.md for detailed migration instructions
• GitHub: Visit the repository for source code and issues
• Comet ML: Learn more about Comet ML at https://www.comet-ml.com

This release represents a significant step forward in CometX's development, with improved reliability, better testing, and enhanced user experience.

This release contains:

1. Fixes to correctly cometx copy remote assets
2. Updated README.md to include cometx config

New in this version:

1. pulled dependencies (except comet_ml) to pip install cometx[all]
2. pinned version of pillow to modern version

Changes in this version:

1. cometx copy dir workspace - now correctly copies datagrid's (data table is not correct though)
2. updated locations of panels in github
3. New api.upload_panel_name("Name")
4. cometx log workspace Name --type panel - allow logging panel-by-name

Changes in this release:

1. cometx smoke-test now tests opik (thank you @christopher-comet)
2. Setup now installs "pillow", "opik", and "comet_mpm" (thank you @christopher-comet)
3. Added video extension check in cometx copy
4. Added cometx log --use-base-name; get all code
5. Added upload panel by name from github

New changes included in this version:

1. Log --type tensorboard-folder-assets with cometx log; creates experiments
2. Added cometx admin chargeback-report
3. Added sync to cometx copy to check before upload
4. Added cometx smoke-test
5. Lots of fixes and enhancements

This release contains:

1. cometx download --from wandb now supports annotation boxes
2. cometx log WORKSPACE URL|ZIP|PY --type panel - log panel to workspace
3. cometx copy workspace/panels dst - copy panels to workspace
4. cometx download workspace/panels source - download panels from workspace
5. Updates to Jupyter %%cometx magic
6. cometx list workspace/panels - list panels
7. cometx list workspace/name_or_id - list panels details
8. Updates to cometx.API() to support panels
9. cometx log workspace FILE1 FILE2... - updated log to handle multiple files
10. cometx copy fixes for confusion matrix

New in this version:

1. Can now copy all asset types, including confusion-matrix and embeddings
2. Bug fixes in download assets
3. Added step to system metrics
4. Copies system metrics
5. Logs "runtime"metrics
6. Added a method cometx.audio.log_audio() that creates waveform and spectrogram figures