deep-solutions
A library that provides useful tools and standard solutions for deep learning tasks.
📦 Installation
Install from PyPI:
pip install deep-solutions
Install from source (for development):
git clone https://github.com/FrostyHec/deep-solutions.git
cd deep-solutions
pip install -e ".[dev]"
🚀 Quick Start
from deep_solutions import hello_world, DeepSolution, format_output
# Simple function
message = hello_world()
print(message) # Output: Hello from deep-solutions!
# Use DeepSolution class
solution = DeepSolution("my_solution")
result = solution.process("data")
print(result) # Output: Processing data with my_solution
# Format output
formatted = format_output("result data", prefix="Output")
print(formatted) # Output: Output: result data
📚 Documentation
| Document | Description |
|---|---|
| Developer Guide | How to clone, setup environment, and contribute |
| Project Structure | Directory structure, dependency management, Python version requirements |
| Code Standards | Commit conventions, PR workflow, merge requirements |
| Local Testing Guide | Using check.sh, tox, pytest, etc. |
| CI Workflow | GitHub Actions CI/CD documentation |
| Publishing Guide | How to publish to PyPI |
Note: Chinese documentation is available in docs/zh-CN/
🛠️ Development
Setup Development Environment
We use the Pip-in-Conda strategy for dependency management:
- Conda manages only Python version and pip
- All package dependencies are managed in
pyproject.toml - This ensures development and production dependencies are always in sync
# Create conda environment (only Python + pip)
conda env create -f environment.yml
# Activate environment
conda activate deep-solutions
# Install package with all dependencies from pyproject.toml
pip install -e ".[dev]"
Run Tests
# Run all tests
pytest
# Run with coverage
pytest --cov=deep_solutions --cov-report=html
Code Quality
# Format code (using Ruff)
ruff format src/ tests/
# Lint code
ruff check src/ tests/
# Type check
mypy src/
# Run all checks at once
./scripts/check.sh
📝 Features
- Core Functionality: Essential deep learning utilities
- Easy to Use: Simple and intuitive API
- Well Tested: Comprehensive test coverage
- Type Hints: Full type annotation support
- Extensible: Easy to extend with new features
📄 License
This project is licensed under the Apache License 2.0 - see the LICENSE file for details.
🤝 Contributing
Contributions are welcome! Please see our Developer Guide for details.
⚠️ Important: Development must be done in Python 3.8 environment. See Project Structure for details.
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Run checks before commit (
./scripts/check.sh) - Commit your changes (
git commit -m 'feat: add amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
Merge Requirements: PRs must pass all CI checks and receive at least one review approval.
📧 Contact
- GitHub: @FrostyHec
- Repository: deep-solutions
🔗 Links
Note: This project is in active development - the API may change in future releases.
Metadata
Release files for deep-solutions 0.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| deep_solutions-0.1.1.tar.gz | 72.9 kB | Without provenance | Details for deep_solutions-0.1.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| deep_solutions-0.1.1-py3-none-any.whl | Python 3 | none | any | Details for deep_solutions-0.1.1-py3-none-any.whl |
Total release size: 82.2 kB
Release files / deep_solutions-0.1.1.tar.gz
| Download URL | deep_solutions-0.1.1.tar.gz |
|---|---|
| Size | 72.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1061f245b232baaf2873df2516644b00e8f59199503342d71c444d8d3693b993
|
|
BLAKE2b-256 checksum How to use checksums |
59c77c131b526ae53392bd1c43614fcd904767af59bd4c7863c09a6dd24de964
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.8.18
|
Release files / deep_solutions-0.1.1-py3-none-any.whl
| Download URL | deep_solutions-0.1.1-py3-none-any.whl |
|---|---|
| Size | 9.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4605d6fc5811cf1899dd58d519e12e366e7be8ade1ee8b68a0f5c149aaa8840d
|
|
BLAKE2b-256 checksum How to use checksums |
dd1df93a02d56413c7ed8c16cf3189319ddab8eda405c29205cdf5654f5355dd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.8.18
|
Security for deep-solutions 0.1.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.