-
Notifications
You must be signed in to change notification settings - Fork 2
Docs update with osa_tool #18
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR implements comprehensive documentation updates using OSA (Open Source Assistant) tool for the WGAN-GP with Meta-Feature Statistics project. The update relocates utility functions from the root level to the wgan_gp module, adds extensive docstrings throughout the codebase, and creates a complete MkDocs-based documentation system.
Key Changes
- Moves
utils.pyfrom root towgan_gp/utils.pywith enhanced documentation - Adds comprehensive docstrings to all modules following Google style
- Creates MkDocs configuration and documentation structure
- Updates dependencies and adds CI/CD workflows for documentation
Reviewed Changes
Copilot reviewed 18 out of 20 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
wgan_gp/utils.py |
New utility module with comprehensive functions and docstrings |
wgan_gp/training.py |
Enhanced training classes with detailed documentation |
wgan_gp/pymfe_to_torch.py |
Meta-feature extraction with improved error handling |
wgan_gp/models.py |
Neural network architectures with complete docstrings |
wgan_gp/main.py |
Updated imports and configuration parameters |
utils.py |
Removed - functionality moved to wgan_gp/utils.py |
osa_mkdocs.yml |
MkDocs configuration for documentation generation |
osa_docs/ |
Documentation source files with module references |
README.md |
Comprehensive project documentation |
req.txt |
Updated dependencies for documentation tools |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| ].values | ||
| real_data_scaled_no_anomalies = real_data_scaled_no_anomalies.values | ||
| y = pd.DataFrame(y[real_data_scaled_no_anomalies.index], columns=["target"]) |
Copilot
AI
Sep 24, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Line 510 assigns .values to real_data_scaled_no_anomalies, converting it to a numpy array. Line 511 then tries to access .index on this numpy array, which will cause an AttributeError since numpy arrays don't have an .index attribute.
| ].values | |
| real_data_scaled_no_anomalies = real_data_scaled_no_anomalies.values | |
| y = pd.DataFrame(y[real_data_scaled_no_anomalies.index], columns=["target"]) | |
| ] | |
| y = pd.DataFrame(y.loc[real_data_scaled_no_anomalies.index], columns=["target"]) | |
| real_data_scaled_no_anomalies = real_data_scaled_no_anomalies.values |
| plot_freq=100, | ||
| # Hyper parameters | ||
| epochs=1000, | ||
| epochs=10, |
Copilot
AI
Sep 24, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The epochs value has been reduced from 1000 to 10, which may be too low for meaningful training. This appears to be a testing/debugging configuration that should likely be reverted to a higher value for actual training.
| epochs=10, | |
| epochs=1000, |
| learning_params |= dict( | ||
| # mfs_lambda = .1, | ||
| mfs_lambda = [.1, 2.], | ||
| mfs_lambda=0.1, | ||
| # mfs_lambda = [.1, 2.], |
Copilot
AI
Sep 24, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The change from list format [.1, 2.] to float 0.1 for mfs_lambda alters the loss computation logic. Ensure this change is intentional and that the training logic in TrainerModified._generator_train_iteration properly handles both float and list cases.
redundant code removed Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Redundant code removed Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
No description provided.