mjkit 0.0.3

No project description provided

mjkit

---

Usage

pip install mjkit

Project Structure

└── /
    ├── LICENSE
    ├── README.md
    ├── assets
    ├── build.sh
    ├── dist
    │   ├── mjkit-0.0.2-py3-none-any.whl
    │   └── mjkit-0.0.2.tar.gz
    ├── mjkit
    │   ├── __init__.py
    │   ├── errors
    │   ├── huggingface
    │   ├── support
    │   └── utiles
    ├── poetry.lock
    ├── poetry.toml
    ├── pyproject.toml
    ├── ruff.toml
    └── test.py

Project Index

/

__root__

⦿ __root__

File Name	Summary
LICENSE	License the project under the MIT License to allow for open-source distribution and modification.
pyproject.toml	- Define the purpose and usage of the mjkit project within the codebase architecture - Highlight its role in managing Python versions and dependencies, emphasizing its compatibility with specific Python versions - Additionally, stress its integration with the holidays package and the twine tool for development tasks.
test.py	Enhances project architecture by integrating functionality from readmeai.
build.sh	- Automates the build process for the project by handling dependencies, updating locks, building packages, and uploading to PyPI - Ensures Poetry availability, Python version compatibility, and valid PyPI API token for successful package deployment - Streamlines the packaging workflow for seamless distribution.
ruff.toml	Define exclusion rules for commonly ignored directories in the project structure to maintain code cleanliness and focus on relevant files.
poetry.toml	Enable project-specific virtual environments for local development.

mjkit

⦿ mjkit

utiles

⦿ mjkit.utiles

File Name	Summary
get_folder_path.py	- Define functions to locate and manage project directories based on specific indicators like .venv, .git, etc - These functions help determine the project root, handle assets folder paths, and create subfolders within the assets directory - The code facilitates easy access and organization of project resources.
financial_dates.py	- Generate financial business days excluding weekends and holidays within a specified date range - The code determines if a given date falls on a weekend or a holiday, filtering out non-business days - This functionality is crucial for financial and securities markets to calculate valid trading days effectively.
format_elapsed_time.py	- Format elapsed time in seconds to a human-readable string - Handles conversions from seconds to minutes, hours, and days - Provides a clear representation of time intervals for better readability - The function is versatile and can be easily integrated into various projects for time-related functionalities.
get_logger.py	- Create a custom logger with emoji tags for improved readability - The get_logger function generates independent loggers for modules, enhancing logging with emoji-tagged messages - The EmojiFormatter class adds emojis to log messages based on their severity levels - Test examples demonstrate the loggers functionality.
suppress_stdout.py	- Enable temporary suppression of standard output during code execution by utilizing the suppress_stdout context manager - This functionality ensures that any print statements or stdout logs generated within the enclosed code block are discarded - The context manager redirects output to the operating systems null device, effectively silencing any output intended for stdout.
timeit.py	- Generate a decorator to measure and log execution time for functions and methods - The decorator captures start time, executes the function, calculates elapsed time, and logs the result - It supports both standalone functions and class methods, providing insightful timing information for various processes within the codebase architecture.

support

⦿ mjkit.support

File Name	Summary
get_exp_save_path.py	- Generate experiment save paths based on date and trial ID, ensuring organized storage for optimization experiments using Optuna - The function creates directories, assigns unique IDs, and returns the path for saving the best model - It offers flexibility for custom trial IDs or generates them automatically if not provided.

huggingface

⦿ mjkit.huggingface

File Name

Summary

create_readme.py

- Generate README markdown for creating Hugging Face Dataset/Card README.md files - The code in create_readme.py constructs README content based on provided metadata like tags, datasets, and descriptions - It ensures a structured YAML header and body sections, including dataset information, usage examples, and last update timestamp - The script simplifies README generation for Hugging Face projects, enhancing project documentation and visibility.

errors

⦿ mjkit.errors

File Name	Summary
error.py	- Define a custom error class, NoDataReceivedError, to handle cases where no data is returned during a query - This class is crucial for managing scenarios where expected data is missing, ensuring robust error handling within the projects architecture.

---