deep-solutions 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,167 @@
1
+ Metadata-Version: 2.4
2
+ Name: deep-solutions
3
+ Version: 0.1.0
4
+ Summary: A Python package for deep learning solutions
5
+ Author-email: ZDHuang <your.email@example.com>
6
+ License: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/FrostyHec/deep-solutions
8
+ Project-URL: Documentation, https://github.com/FrostyHec/deep-solutions/blob/main/README.md
9
+ Project-URL: Repository, https://github.com/FrostyHec/deep-solutions
10
+ Project-URL: Issues, https://github.com/FrostyHec/deep-solutions/issues
11
+ Keywords: deep-learning,machine-learning,solutions
12
+ Classifier: Development Status :: 3 - Alpha
13
+ Classifier: Intended Audience :: Developers
14
+ Classifier: License :: OSI Approved :: Apache Software License
15
+ Classifier: Programming Language :: Python :: 3
16
+ Classifier: Programming Language :: Python :: 3.8
17
+ Classifier: Programming Language :: Python :: 3.9
18
+ Classifier: Programming Language :: Python :: 3.10
19
+ Classifier: Programming Language :: Python :: 3.11
20
+ Classifier: Programming Language :: Python :: 3.12
21
+ Requires-Python: >=3.8
22
+ Description-Content-Type: text/markdown
23
+ License-File: LICENSE
24
+ Requires-Dist: numpy>=1.24.0
25
+ Requires-Dist: scipy>=1.10.0
26
+ Provides-Extra: dev
27
+ Requires-Dist: pytest>=7.0.0; extra == "dev"
28
+ Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
29
+ Requires-Dist: black>=23.0.0; extra == "dev"
30
+ Requires-Dist: isort>=5.12.0; extra == "dev"
31
+ Requires-Dist: flake8>=6.0.0; extra == "dev"
32
+ Requires-Dist: mypy>=1.0.0; extra == "dev"
33
+ Requires-Dist: build>=0.10.0; extra == "dev"
34
+ Requires-Dist: twine>=4.0.0; extra == "dev"
35
+ Provides-Extra: docs
36
+ Requires-Dist: sphinx>=6.0.0; extra == "docs"
37
+ Requires-Dist: sphinx-rtd-theme>=1.2.0; extra == "docs"
38
+ Dynamic: license-file
39
+
40
+ # deep-solutions
41
+
42
+ A library that provides useful tools and standard solutions for deep learning tasks.
43
+
44
+ [![PyPI version](https://badge.fury.io/py/deep-solutions.svg)](https://badge.fury.io/py/deep-solutions)
45
+ [![Python Version](https://img.shields.io/pypi/pyversions/deep-solutions)](https://pypi.org/project/deep-solutions/)
46
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
47
+
48
+ ## 📦 Installation
49
+
50
+ Install from PyPI:
51
+
52
+ ```bash
53
+ pip install deep-solutions
54
+ ```
55
+
56
+ Install from source (for development):
57
+
58
+ ```bash
59
+ git clone https://github.com/FrostyHec/deep-solutions.git
60
+ cd deep-solutions
61
+ pip install -e ".[dev]"
62
+ ```
63
+
64
+ ## 🚀 Quick Start
65
+
66
+ ```python
67
+ from deep_solutions import hello_world, DeepSolution, format_output
68
+
69
+ # Simple function
70
+ message = hello_world()
71
+ print(message) # Output: Hello from deep-solutions!
72
+
73
+ # Use DeepSolution class
74
+ solution = DeepSolution("my_solution")
75
+ result = solution.process("data")
76
+ print(result) # Output: Processing data with my_solution
77
+
78
+ # Format output
79
+ formatted = format_output("result data", prefix="Output")
80
+ print(formatted) # Output: Output: result data
81
+ ```
82
+
83
+ ## 📚 Documentation
84
+
85
+ - [Developer Guide](docs/developers.md) - How to contribute to this project
86
+ - [PyPI Publishing Guide](docs/pypi_publishing.md) - How to publish to PyPI
87
+ - [API Exposure Guide](.nonpublic/prompts/dev/v0.0.1/repo_init/A002_API暴露方案.md) - Best practices for API design
88
+
89
+ ## 🛠️ Development
90
+
91
+ ### Setup Development Environment
92
+
93
+ We use the **Pip-in-Conda** strategy for dependency management:
94
+ - Conda manages only Python version and pip
95
+ - All package dependencies are managed in `pyproject.toml`
96
+ - This ensures development and production dependencies are always in sync
97
+
98
+ ```bash
99
+ # Create conda environment (only Python + pip)
100
+ conda env create -f environment.yml
101
+
102
+ # Activate environment
103
+ conda activate deep-solutions
104
+
105
+ # Install package with all dependencies from pyproject.toml
106
+ pip install -e ".[dev]"
107
+ ```
108
+
109
+ ### Run Tests
110
+
111
+ ```bash
112
+ # Run all tests
113
+ pytest
114
+
115
+ # Run with coverage
116
+ pytest --cov=deep_solutions --cov-report=html
117
+ ```
118
+
119
+ ### Code Quality
120
+
121
+ ```bash
122
+ # Format code
123
+ black src/ tests/
124
+ isort src/ tests/
125
+
126
+ # Check code quality
127
+ flake8 src/ tests/
128
+ mypy src/
129
+ ```
130
+
131
+ ## 📝 Features
132
+
133
+ - **Core Functionality**: Essential deep learning utilities
134
+ - **Easy to Use**: Simple and intuitive API
135
+ - **Well Tested**: Comprehensive test coverage
136
+ - **Type Hints**: Full type annotation support
137
+ - **Extensible**: Easy to extend with new features
138
+
139
+ ## 📄 License
140
+
141
+ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
142
+
143
+ ## 🤝 Contributing
144
+
145
+ Contributions are welcome! Please see our [Developer Guide](docs/developers.md) for details on how to contribute.
146
+
147
+ 1. Fork the repository
148
+ 2. Create your feature branch (`git checkout -b feature/amazing-feature`)
149
+ 3. Commit your changes (`git commit -m 'feat: add amazing feature'`)
150
+ 4. Push to the branch (`git push origin feature/amazing-feature`)
151
+ 5. Open a Pull Request
152
+
153
+ ## 📧 Contact
154
+
155
+ - **Author**: ZDHuang
156
+ - **GitHub**: [@FrostyHec](https://github.com/FrostyHec)
157
+ - **Repository**: [deep-solutions](https://github.com/FrostyHec/deep-solutions)
158
+
159
+ ## 🔗 Links
160
+
161
+ - [PyPI Package](https://pypi.org/project/deep-solutions/)
162
+ - [GitHub Repository](https://github.com/FrostyHec/deep-solutions)
163
+ - [Issue Tracker](https://github.com/FrostyHec/deep-solutions/issues)
164
+
165
+ ---
166
+
167
+ **Note**: This is version 0.1.0 - the API may change in future releases.
@@ -0,0 +1,128 @@
1
+ # deep-solutions
2
+
3
+ A library that provides useful tools and standard solutions for deep learning tasks.
4
+
5
+ [![PyPI version](https://badge.fury.io/py/deep-solutions.svg)](https://badge.fury.io/py/deep-solutions)
6
+ [![Python Version](https://img.shields.io/pypi/pyversions/deep-solutions)](https://pypi.org/project/deep-solutions/)
7
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
8
+
9
+ ## 📦 Installation
10
+
11
+ Install from PyPI:
12
+
13
+ ```bash
14
+ pip install deep-solutions
15
+ ```
16
+
17
+ Install from source (for development):
18
+
19
+ ```bash
20
+ git clone https://github.com/FrostyHec/deep-solutions.git
21
+ cd deep-solutions
22
+ pip install -e ".[dev]"
23
+ ```
24
+
25
+ ## 🚀 Quick Start
26
+
27
+ ```python
28
+ from deep_solutions import hello_world, DeepSolution, format_output
29
+
30
+ # Simple function
31
+ message = hello_world()
32
+ print(message) # Output: Hello from deep-solutions!
33
+
34
+ # Use DeepSolution class
35
+ solution = DeepSolution("my_solution")
36
+ result = solution.process("data")
37
+ print(result) # Output: Processing data with my_solution
38
+
39
+ # Format output
40
+ formatted = format_output("result data", prefix="Output")
41
+ print(formatted) # Output: Output: result data
42
+ ```
43
+
44
+ ## 📚 Documentation
45
+
46
+ - [Developer Guide](docs/developers.md) - How to contribute to this project
47
+ - [PyPI Publishing Guide](docs/pypi_publishing.md) - How to publish to PyPI
48
+ - [API Exposure Guide](.nonpublic/prompts/dev/v0.0.1/repo_init/A002_API暴露方案.md) - Best practices for API design
49
+
50
+ ## 🛠️ Development
51
+
52
+ ### Setup Development Environment
53
+
54
+ We use the **Pip-in-Conda** strategy for dependency management:
55
+ - Conda manages only Python version and pip
56
+ - All package dependencies are managed in `pyproject.toml`
57
+ - This ensures development and production dependencies are always in sync
58
+
59
+ ```bash
60
+ # Create conda environment (only Python + pip)
61
+ conda env create -f environment.yml
62
+
63
+ # Activate environment
64
+ conda activate deep-solutions
65
+
66
+ # Install package with all dependencies from pyproject.toml
67
+ pip install -e ".[dev]"
68
+ ```
69
+
70
+ ### Run Tests
71
+
72
+ ```bash
73
+ # Run all tests
74
+ pytest
75
+
76
+ # Run with coverage
77
+ pytest --cov=deep_solutions --cov-report=html
78
+ ```
79
+
80
+ ### Code Quality
81
+
82
+ ```bash
83
+ # Format code
84
+ black src/ tests/
85
+ isort src/ tests/
86
+
87
+ # Check code quality
88
+ flake8 src/ tests/
89
+ mypy src/
90
+ ```
91
+
92
+ ## 📝 Features
93
+
94
+ - **Core Functionality**: Essential deep learning utilities
95
+ - **Easy to Use**: Simple and intuitive API
96
+ - **Well Tested**: Comprehensive test coverage
97
+ - **Type Hints**: Full type annotation support
98
+ - **Extensible**: Easy to extend with new features
99
+
100
+ ## 📄 License
101
+
102
+ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
103
+
104
+ ## 🤝 Contributing
105
+
106
+ Contributions are welcome! Please see our [Developer Guide](docs/developers.md) for details on how to contribute.
107
+
108
+ 1. Fork the repository
109
+ 2. Create your feature branch (`git checkout -b feature/amazing-feature`)
110
+ 3. Commit your changes (`git commit -m 'feat: add amazing feature'`)
111
+ 4. Push to the branch (`git push origin feature/amazing-feature`)
112
+ 5. Open a Pull Request
113
+
114
+ ## 📧 Contact
115
+
116
+ - **Author**: ZDHuang
117
+ - **GitHub**: [@FrostyHec](https://github.com/FrostyHec)
118
+ - **Repository**: [deep-solutions](https://github.com/FrostyHec/deep-solutions)
119
+
120
+ ## 🔗 Links
121
+
122
+ - [PyPI Package](https://pypi.org/project/deep-solutions/)
123
+ - [GitHub Repository](https://github.com/FrostyHec/deep-solutions)
124
+ - [Issue Tracker](https://github.com/FrostyHec/deep-solutions/issues)
125
+
126
+ ---
127
+
128
+ **Note**: This is version 0.1.0 - the API may change in future releases.
@@ -0,0 +1,78 @@
1
+ [build-system]
2
+ requires = ["setuptools>=61.0", "wheel"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "deep-solutions"
7
+ version = "0.1.0"
8
+ description = "A Python package for deep learning solutions"
9
+ readme = "README.md"
10
+ license = {text = "Apache-2.0"}
11
+ authors = [
12
+ {name = "ZDHuang", email = "your.email@example.com"}
13
+ ]
14
+ keywords = ["deep-learning", "machine-learning", "solutions"]
15
+ requires-python = ">=3.8"
16
+ classifiers = [
17
+ "Development Status :: 3 - Alpha",
18
+ "Intended Audience :: Developers",
19
+ "License :: OSI Approved :: Apache Software License",
20
+ "Programming Language :: Python :: 3",
21
+ "Programming Language :: Python :: 3.8",
22
+ "Programming Language :: Python :: 3.9",
23
+ "Programming Language :: Python :: 3.10",
24
+ "Programming Language :: Python :: 3.11",
25
+ "Programming Language :: Python :: 3.12",
26
+ ]
27
+
28
+ # Core dependencies
29
+ dependencies = [
30
+ "numpy>=1.24.0",
31
+ "scipy>=1.10.0",
32
+ ]
33
+
34
+ [project.optional-dependencies]
35
+ dev = [
36
+ "pytest>=7.0.0",
37
+ "pytest-cov>=4.0.0",
38
+ "black>=23.0.0",
39
+ "isort>=5.12.0",
40
+ "flake8>=6.0.0",
41
+ "mypy>=1.0.0",
42
+ "build>=0.10.0",
43
+ "twine>=4.0.0",
44
+ ]
45
+ docs = [
46
+ "sphinx>=6.0.0",
47
+ "sphinx-rtd-theme>=1.2.0",
48
+ ]
49
+
50
+ [project.urls]
51
+ Homepage = "https://github.com/FrostyHec/deep-solutions"
52
+ Documentation = "https://github.com/FrostyHec/deep-solutions/blob/main/README.md"
53
+ Repository = "https://github.com/FrostyHec/deep-solutions"
54
+ Issues = "https://github.com/FrostyHec/deep-solutions/issues"
55
+
56
+ [tool.setuptools]
57
+ package-dir = {"" = "src"}
58
+
59
+ [tool.setuptools.packages.find]
60
+ where = ["src"]
61
+ include = ["deep_solutions*"]
62
+ exclude = ["tests*"]
63
+
64
+ [tool.black]
65
+ line-length = 88
66
+ target-version = ['py38']
67
+ include = '\.pyi?$'
68
+
69
+ [tool.isort]
70
+ profile = "black"
71
+ line_length = 88
72
+
73
+ [tool.pytest.ini_options]
74
+ testpaths = ["tests"]
75
+ python_files = ["test_*.py"]
76
+ python_classes = ["Test*"]
77
+ python_functions = ["test_*"]
78
+ addopts = "-v --cov=deep_solutions --cov-report=term-missing"
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
@@ -0,0 +1,15 @@
1
+ """
2
+ deep-solutions: A Python package for deep learning solutions.
3
+ """
4
+
5
+ from .core import hello_world, DeepSolution
6
+ from .utils import format_output
7
+
8
+ __version__ = "0.1.0"
9
+
10
+ # Public API - explicitly list what should be exposed
11
+ __all__ = [
12
+ "hello_world",
13
+ "DeepSolution",
14
+ "format_output",
15
+ ]
@@ -0,0 +1,40 @@
1
+ """
2
+ Core functionality for deep-solutions package.
3
+ """
4
+
5
+
6
+ def hello_world():
7
+ """
8
+ A simple example function.
9
+
10
+ Returns:
11
+ str: A greeting message.
12
+ """
13
+ return "Hello from deep-solutions!"
14
+
15
+
16
+ class DeepSolution:
17
+ """
18
+ Main class for deep solutions.
19
+ """
20
+
21
+ def __init__(self, name: str = "default"):
22
+ """
23
+ Initialize a DeepSolution instance.
24
+
25
+ Args:
26
+ name: Name of the solution.
27
+ """
28
+ self.name = name
29
+
30
+ def process(self, data):
31
+ """
32
+ Process data using the solution.
33
+
34
+ Args:
35
+ data: Input data to process.
36
+
37
+ Returns:
38
+ Processed data.
39
+ """
40
+ return f"Processing {data} with {self.name}"
@@ -0,0 +1,24 @@
1
+ """
2
+ Utility functions for deep-solutions package.
3
+ """
4
+
5
+
6
+ def format_output(data, prefix: str = "Result"):
7
+ """
8
+ Format output data with a prefix.
9
+
10
+ Args:
11
+ data: Data to format.
12
+ prefix: Prefix string.
13
+
14
+ Returns:
15
+ str: Formatted output.
16
+ """
17
+ return f"{prefix}: {data}"
18
+
19
+
20
+ def _internal_helper():
21
+ """
22
+ Internal helper function (not exposed in public API).
23
+ """
24
+ return "Internal use only"
@@ -0,0 +1,167 @@
1
+ Metadata-Version: 2.4
2
+ Name: deep-solutions
3
+ Version: 0.1.0
4
+ Summary: A Python package for deep learning solutions
5
+ Author-email: ZDHuang <your.email@example.com>
6
+ License: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/FrostyHec/deep-solutions
8
+ Project-URL: Documentation, https://github.com/FrostyHec/deep-solutions/blob/main/README.md
9
+ Project-URL: Repository, https://github.com/FrostyHec/deep-solutions
10
+ Project-URL: Issues, https://github.com/FrostyHec/deep-solutions/issues
11
+ Keywords: deep-learning,machine-learning,solutions
12
+ Classifier: Development Status :: 3 - Alpha
13
+ Classifier: Intended Audience :: Developers
14
+ Classifier: License :: OSI Approved :: Apache Software License
15
+ Classifier: Programming Language :: Python :: 3
16
+ Classifier: Programming Language :: Python :: 3.8
17
+ Classifier: Programming Language :: Python :: 3.9
18
+ Classifier: Programming Language :: Python :: 3.10
19
+ Classifier: Programming Language :: Python :: 3.11
20
+ Classifier: Programming Language :: Python :: 3.12
21
+ Requires-Python: >=3.8
22
+ Description-Content-Type: text/markdown
23
+ License-File: LICENSE
24
+ Requires-Dist: numpy>=1.24.0
25
+ Requires-Dist: scipy>=1.10.0
26
+ Provides-Extra: dev
27
+ Requires-Dist: pytest>=7.0.0; extra == "dev"
28
+ Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
29
+ Requires-Dist: black>=23.0.0; extra == "dev"
30
+ Requires-Dist: isort>=5.12.0; extra == "dev"
31
+ Requires-Dist: flake8>=6.0.0; extra == "dev"
32
+ Requires-Dist: mypy>=1.0.0; extra == "dev"
33
+ Requires-Dist: build>=0.10.0; extra == "dev"
34
+ Requires-Dist: twine>=4.0.0; extra == "dev"
35
+ Provides-Extra: docs
36
+ Requires-Dist: sphinx>=6.0.0; extra == "docs"
37
+ Requires-Dist: sphinx-rtd-theme>=1.2.0; extra == "docs"
38
+ Dynamic: license-file
39
+
40
+ # deep-solutions
41
+
42
+ A library that provides useful tools and standard solutions for deep learning tasks.
43
+
44
+ [![PyPI version](https://badge.fury.io/py/deep-solutions.svg)](https://badge.fury.io/py/deep-solutions)
45
+ [![Python Version](https://img.shields.io/pypi/pyversions/deep-solutions)](https://pypi.org/project/deep-solutions/)
46
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
47
+
48
+ ## 📦 Installation
49
+
50
+ Install from PyPI:
51
+
52
+ ```bash
53
+ pip install deep-solutions
54
+ ```
55
+
56
+ Install from source (for development):
57
+
58
+ ```bash
59
+ git clone https://github.com/FrostyHec/deep-solutions.git
60
+ cd deep-solutions
61
+ pip install -e ".[dev]"
62
+ ```
63
+
64
+ ## 🚀 Quick Start
65
+
66
+ ```python
67
+ from deep_solutions import hello_world, DeepSolution, format_output
68
+
69
+ # Simple function
70
+ message = hello_world()
71
+ print(message) # Output: Hello from deep-solutions!
72
+
73
+ # Use DeepSolution class
74
+ solution = DeepSolution("my_solution")
75
+ result = solution.process("data")
76
+ print(result) # Output: Processing data with my_solution
77
+
78
+ # Format output
79
+ formatted = format_output("result data", prefix="Output")
80
+ print(formatted) # Output: Output: result data
81
+ ```
82
+
83
+ ## 📚 Documentation
84
+
85
+ - [Developer Guide](docs/developers.md) - How to contribute to this project
86
+ - [PyPI Publishing Guide](docs/pypi_publishing.md) - How to publish to PyPI
87
+ - [API Exposure Guide](.nonpublic/prompts/dev/v0.0.1/repo_init/A002_API暴露方案.md) - Best practices for API design
88
+
89
+ ## 🛠️ Development
90
+
91
+ ### Setup Development Environment
92
+
93
+ We use the **Pip-in-Conda** strategy for dependency management:
94
+ - Conda manages only Python version and pip
95
+ - All package dependencies are managed in `pyproject.toml`
96
+ - This ensures development and production dependencies are always in sync
97
+
98
+ ```bash
99
+ # Create conda environment (only Python + pip)
100
+ conda env create -f environment.yml
101
+
102
+ # Activate environment
103
+ conda activate deep-solutions
104
+
105
+ # Install package with all dependencies from pyproject.toml
106
+ pip install -e ".[dev]"
107
+ ```
108
+
109
+ ### Run Tests
110
+
111
+ ```bash
112
+ # Run all tests
113
+ pytest
114
+
115
+ # Run with coverage
116
+ pytest --cov=deep_solutions --cov-report=html
117
+ ```
118
+
119
+ ### Code Quality
120
+
121
+ ```bash
122
+ # Format code
123
+ black src/ tests/
124
+ isort src/ tests/
125
+
126
+ # Check code quality
127
+ flake8 src/ tests/
128
+ mypy src/
129
+ ```
130
+
131
+ ## 📝 Features
132
+
133
+ - **Core Functionality**: Essential deep learning utilities
134
+ - **Easy to Use**: Simple and intuitive API
135
+ - **Well Tested**: Comprehensive test coverage
136
+ - **Type Hints**: Full type annotation support
137
+ - **Extensible**: Easy to extend with new features
138
+
139
+ ## 📄 License
140
+
141
+ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
142
+
143
+ ## 🤝 Contributing
144
+
145
+ Contributions are welcome! Please see our [Developer Guide](docs/developers.md) for details on how to contribute.
146
+
147
+ 1. Fork the repository
148
+ 2. Create your feature branch (`git checkout -b feature/amazing-feature`)
149
+ 3. Commit your changes (`git commit -m 'feat: add amazing feature'`)
150
+ 4. Push to the branch (`git push origin feature/amazing-feature`)
151
+ 5. Open a Pull Request
152
+
153
+ ## 📧 Contact
154
+
155
+ - **Author**: ZDHuang
156
+ - **GitHub**: [@FrostyHec](https://github.com/FrostyHec)
157
+ - **Repository**: [deep-solutions](https://github.com/FrostyHec/deep-solutions)
158
+
159
+ ## 🔗 Links
160
+
161
+ - [PyPI Package](https://pypi.org/project/deep-solutions/)
162
+ - [GitHub Repository](https://github.com/FrostyHec/deep-solutions)
163
+ - [Issue Tracker](https://github.com/FrostyHec/deep-solutions/issues)
164
+
165
+ ---
166
+
167
+ **Note**: This is version 0.1.0 - the API may change in future releases.
@@ -0,0 +1,13 @@
1
+ LICENSE
2
+ README.md
3
+ pyproject.toml
4
+ src/deep_solutions/__init__.py
5
+ src/deep_solutions/core.py
6
+ src/deep_solutions/utils.py
7
+ src/deep_solutions.egg-info/PKG-INFO
8
+ src/deep_solutions.egg-info/SOURCES.txt
9
+ src/deep_solutions.egg-info/dependency_links.txt
10
+ src/deep_solutions.egg-info/requires.txt
11
+ src/deep_solutions.egg-info/top_level.txt
12
+ tests/test_core.py
13
+ tests/test_utils.py
@@ -0,0 +1,16 @@
1
+ numpy>=1.24.0
2
+ scipy>=1.10.0
3
+
4
+ [dev]
5
+ pytest>=7.0.0
6
+ pytest-cov>=4.0.0
7
+ black>=23.0.0
8
+ isort>=5.12.0
9
+ flake8>=6.0.0
10
+ mypy>=1.0.0
11
+ build>=0.10.0
12
+ twine>=4.0.0
13
+
14
+ [docs]
15
+ sphinx>=6.0.0
16
+ sphinx-rtd-theme>=1.2.0
@@ -0,0 +1 @@
1
+ deep_solutions
@@ -0,0 +1,28 @@
1
+ """
2
+ Tests for core module.
3
+ """
4
+ import pytest
5
+ from deep_solutions import hello_world, DeepSolution
6
+
7
+
8
+ def test_hello_world():
9
+ """Test hello_world function."""
10
+ result = hello_world()
11
+ assert result == "Hello from deep-solutions!"
12
+ assert isinstance(result, str)
13
+
14
+
15
+ def test_deep_solution_init():
16
+ """Test DeepSolution initialization."""
17
+ solution = DeepSolution("test")
18
+ assert solution.name == "test"
19
+
20
+ default_solution = DeepSolution()
21
+ assert default_solution.name == "default"
22
+
23
+
24
+ def test_deep_solution_process():
25
+ """Test DeepSolution process method."""
26
+ solution = DeepSolution("my_solution")
27
+ result = solution.process("data")
28
+ assert result == "Processing data with my_solution"
@@ -0,0 +1,24 @@
1
+ """
2
+ Tests for utils module.
3
+ """
4
+ import pytest
5
+ from deep_solutions import format_output
6
+
7
+
8
+ def test_format_output_default():
9
+ """Test format_output with default prefix."""
10
+ result = format_output("test data")
11
+ assert result == "Result: test data"
12
+
13
+
14
+ def test_format_output_custom_prefix():
15
+ """Test format_output with custom prefix."""
16
+ result = format_output("test data", prefix="Output")
17
+ assert result == "Output: test data"
18
+
19
+
20
+ def test_format_output_various_types():
21
+ """Test format_output with different data types."""
22
+ assert format_output(123) == "Result: 123"
23
+ assert format_output([1, 2, 3]) == "Result: [1, 2, 3]"
24
+ assert format_output({"key": "value"}) == "Result: {'key': 'value'}"