diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 100644 index 6886247a..00000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,92 +0,0 @@ - - -# Community Code of Conduct - -## Our Pledge - -In the interest of fostering an open and welcoming environment, we as -contributors and maintainers pledge to making participation in our project and -our community a harassment-free experience for everyone, regardless of age, body -size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, -level of experience, education, socio-economic status, nationality, personal -appearance, race, religion, or sexual identity and orientation. - -## Our Standards - -Examples of behavior that contributes to creating a positive environment -include: - -* Using welcoming and inclusive language -* Being respectful of differing viewpoints and experiences -* Gracefully accepting constructive criticism -* Focusing on what is best for the community -* Showing empathy towards other community members - -Examples of unacceptable behavior by participants include: - -* The use of sexualized language or imagery and unwelcome sexual attention or - advances -* Trolling, insulting/derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or electronic - address, without explicit permission -* Other conduct which could reasonably be considered inappropriate in a - professional setting - -## Our Responsibilities - -Project maintainers are responsible for clarifying the standards of acceptable -behavior and are expected to take appropriate and fair corrective action in -response to any instances of unacceptable behavior. - -Project maintainers have the right and responsibility to remove, edit, or -reject comments, commits, code, wiki edits, issues, and other contributions -that are not aligned to this Code of Conduct, or to ban temporarily or -permanently any contributor for other behaviors that they deem inappropriate, -threatening, offensive, or harmful. - -## Scope - -This Code of Conduct applies both within project spaces and in public spaces -when an individual is representing the project or its community. Examples of -representing a project or community include using an official project e-mail -address, posting via an official social media account, or acting as an appointed -representative at an online or offline event. Representation of a project may be -further defined and clarified by project maintainers. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team using the [Neural Magic Contact Us Form](https://neuralmagic.com/contact). All -complaints will be reviewed and investigated and will result in a response that -is deemed necessary and appropriate to the circumstances. The project team is -obligated to maintain confidentiality with regard to the reporter of an incident. -Further details of specific enforcement policies may be posted separately. - -Project maintainers who do not follow or enforce the Code of Conduct in good -faith may face temporary or permanent repercussions as determined by other -members of the project's leadership. - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, -available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html - -[homepage]: https://www.contributor-covenant.org - -For answers to common questions about this code of conduct, see -https://www.contributor-covenant.org/faq diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index e7243d2c..00000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,84 +0,0 @@ - - -# Contributing to SparseZoo - -If you’re reading this, hopefully we have piqued your interest to take the next step. Join us and help make SparseZoo even better! As a contributor, here are some community guidelines we would like you to follow: - -- [Code of Conduct](#code-of-conduct) -- [Ways to Contribute](#ways-to-contribute) -- [Bugs and Feature Requests](#bugs-and-feature-requests) -- [Question or Problem](#question-or-problem) -- [Developing SparseZoo](DEVELOPING.md) - -## Code of Conduct - -Help us keep the software inclusive. Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md) in order to promote an environment that is friendly, fair, respectful, and safe. We want to inspire collaboration, innovation, and fun! - -## Ways to Contribute - -Whether you’re a newbie, dabbler, or expert, we appreciate you jumping in. - -### Contributing Code - -- Make pull requests for addressing bugs, open issues, and documentation -- Neural Magic as the maintainer will do reviews and final merge - -### Reporting In - -- See something, say something: bugs, documentation -- Propose new feature requests to Neural Magic - -### Helping Others - -- Answer open discussion topics -- Spread the word about SparseZoo -- Teach and empower others. This is the way! - -## Bugs and Feature Requests - -Please search through existing issues and requests first to avoid duplicates. Neural Magic will work with you further to take next steps. - -- Go to: [GitHub Issues](https://github.com/neuralmagic/sparsezoo/issues)
- -For bugs, include: - -- brief summary -- OS/Environment details -- steps to reproduce (s.t.r.) -- code snippets, screenshots/casts, log content, sample models -- add the GitHub label "bug" to your post - -For feature requests, including SparseZoo model additions, include: - -- problem you’re trying to solve -- community benefits -- other relevant details to support your proposal -- add the GitHub label "enhancement" to your post - -For documentation edits, include: - -- current state, proposed state -- if applicable, screenshots/casts -- add the GitHub label "documentation" to your post - -## Question or Problem - -Sign up or log in to our [**Neural Magic Community Slack**](https://neuralmagic.com/community/). We are growing the community member by member and happy to see you there. Post all other questions including support or how to contribute. Don’t forget to search through existing discussions to avoid duplication! Thanks! - -## Developing SparseZoo - -Made it this far? Review [Developing SparseZoo](DEVELOPING.md) to get started. diff --git a/DEVELOPING.md b/DEVELOPING.md deleted file mode 100644 index adda8a7f..00000000 --- a/DEVELOPING.md +++ /dev/null @@ -1,150 +0,0 @@ - - -# Developing SparseZoo - -SparseZoo is developed and tested using Python 3.8-3.11. -To develop sparsezoo, you will also need the development dependencies and to follow the styling guidelines. - -Here are some details to get started. - -## Basic Commands - -**Development Installation** - -```bash -git clone https://github.com/neuralmagic/sparsezoo.git -cd sparsezoo -python3 -m pip install -e ./[dev] -``` - -This will clone the SparseZoo repo, install it, and install the development dependencies. - -**Code Styling and Formatting checks** - -```bash -make style -make quality -``` - -This will run automatic code styling using `black` and `isort` and test that the -repository's code matches its standards. - -**EXAMPLE: test changes locally** - -```bash -make test -``` - -This will run all SparseZoo unit tests. -File any error found before changes as an Issue and fix any errors found after making changes before submitting a Pull Request. - - -## GitHub Workflow - -1. Fork the `neuralmagic/sparsezoo` repository into your GitHub account: https://github.com/neuralmagic/sparsezoo/fork. - -2. Clone your fork of the GitHub repository, replacing `` with your GitHub username. - - Use ssh (recommended): - - ```bash - git clone git@github.com:/sparsezoo.git - ``` - - Or https: - - ```bash - git clone https://github.com//sparsezoo.git - ``` - -3. Add a remote to keep up with upstream changes. - - ```bash - git remote add upstream https://github.com/neuralmagic/sparsezoo.git - ``` - - If you already have a copy, fetch upstream changes. - - ```bash - git fetch upstream - ``` - -4. Create a feature branch to work in. - - ```bash - git checkout -b feature-xxx remotes/upstream/main - ``` - -5. Work in your feature branch. - - ```bash - git commit -a - ``` - -6. Periodically rebase your changes - - ```bash - git pull --rebase - ``` - -7. When done, combine ("squash") related commits into a single one - - ```bash - git rebase -i upstream/main - ``` - - This will open your editor and allow you to re-order commits and merge them: - - Re-order the lines to change commit order (to the extent possible without creating conflicts) - - Prefix commits using `s` (squash) or `f` (fixup) to merge extraneous commits. - -8. Submit a pull-request - - ```bash - git push origin feature-xxx - ``` - - Go to your fork main page - - ```bash - https://github.com//sparsezoo - ``` - - If you recently pushed your changes GitHub will automatically pop up a `Compare & pull request` button for any branches you recently pushed to. If you click that button it will automatically offer you to submit your pull-request to the `neuralmagic/sparsezoo` repository. - - - Give your pull-request a meaningful title. - You'll know your title is properly formatted once the `Semantic Pull Request` GitHub check - transitions from a status of "pending" to "passed". - - In the description, explain your changes and the problem they are solving. - -9. Addressing code review comments - - Repeat steps 5. through 7. to address any code review comments and rebase your changes if necessary. - - Push your updated changes to update the pull request - - ```bash - git push origin [--force] feature-xxx - ``` - - `--force` may be necessary to overwrite your existing pull request in case your - commit history was changed when performing the rebase. - - Note: Be careful when using `--force` since you may lose data if you are not careful. - - ```bash - git push origin --force feature-xxx - ``` diff --git a/MANIFEST.in b/MANIFEST.in index 36092af3..1aba38f6 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,2 +1 @@ include LICENSE -include src/sparsezoo/deployment_package/docker/* \ No newline at end of file diff --git a/NOTICE b/NOTICE index 6ada1cc7..2f34de8a 100644 --- a/NOTICE +++ b/NOTICE @@ -1,5 +1,8 @@ +This repo has reached end-of-life and is no longer supported as of June 2025. +See the repo's README for more details; NOTICE remains for informational purposes only. + SparseZoo -Copyright 2021 - present / Neuralmagic, Inc. All Rights Reserved. +Copyright 2021 - 2025 / Neuralmagic, Inc. All Rights Reserved. This product includes software developed at Neuralmagic, Inc. (https://www.neuralmagic.com). diff --git a/README.md b/README.md index fd1a3961..1bcba4eb 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@