We're happy about all kinds of contributions and feedback to Autoencodix. For feedback you can use the issue board or send us an mail. If you want to contribute with code, please open a pull request to either work on your own idea or tackling an exisiting issue is a good starting point. If you are unsure, or confused about something, please just open an issue , we will try to adress it. We also value non-code contributions in the form of a feature request or bug report.
Have a great idea for a new feature in Autoencodix? Let us know by submitting a feature request! We are in particular interested in expanding the number of architectures and related options. Hence, we value your input what might be missing in order to enable your application and research on autoencoders with our framework.
If you'd like to take the initiative, feel free to fork Autoencodix, work on implementing the feature, and submit a patch. Before starting, it is best to open an issue first to describe your enhancement. This helps you to get an early feedback and ensures that your work can be effectively incorporated into the Autoencodix codebase, saving time and aligning with the project’s direction.
Even the smartest Gaul can make mistakes, so if you encounter a bug when using Autoencodix, we highly appreciate a bug report. When submitting a bug report, please provide as much context as possible. In particular, always attach the related YAML-config causing the issue. Further, depending on the issue try to include details like the Python version, Autoencodix version, any error messages or stack traces, and clear steps to reproduce the issue (if possible, include a small sample dataset that triggers the error). The more information provided, the easier it will be to address the issue effectively
Interested in contributing to Autoencodix? Fantastic!
If there are open issues, feel free to start with those (especially ones labeled "good first issue"). Have your own ideas? That’s welcome too! Before diving into significant changes, it’s recommended to open an issue describing what you plan to work on to get feedback early.
To contribute, fork the repository, push your changes to your fork, and submit a Pull Request.
Detailed guidelines, including instructions on running tests, will be provided soon. These will likely be outlined in a DEVELOPMENT.md file.
Still questions? Reach out to us.