Merge pull request #4 from pyc-team/factors

Rewrite and Reframe of Library (PyC v1.0.0a1)

Author: gdefe

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,26 @@
+---
+name: Bug Report
+about: Report a bug in PyC
+---
+
+# Bug Report
+
+## Description
+A clear and concise description of the problem.
+
+## To Reproduce
+Steps to reproduce:
+1.
+2.
+3.
+
+## Expected Behavior
+What you expected to happen.
+
+## Environment
+- PyC version:
+- Python version:
+- OS:
+
+## Additional Information
+Anything else we should know?

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,18 @@
+---
+name: Feature Request
+about: Suggest a new idea for PyC
+---
+
+# Feature Request
+
+## Description
+What feature would you like to see?
+
+## Motivation
+Why is this feature useful?
+
+## Alternatives
+Any alternative solutions you considered?
+
+## Additional Information
+Anything else we should know?

.github/ISSUE_TEMPLATE/pull_request_template.md

@@ -0,0 +1,20 @@
+# Pull Request
+
+## Description
+Describe the changes you made and why they are necessary.
+
+## Related Issues
+Link any related issues (e.g., #123).
+
+## Changes Made
+- [ ] Feature added
+- [ ] Bug fixed
+- [ ] Documentation updated
+- [ ] Other (please specify)
+
+## Checklist
+- [ ] Tests added or updated
+- [ ] Documentation updated
+- [ ] Code follows style guidelines
+
+Thank you for contributing to PyC! — The PyC Team

.github/workflows/coverage.yml

@@ -0,0 +1,44 @@
+name: Coverage
+
+on:
+  push:
+    branches: [ "**" ]  # Run on all branches
+  pull_request:
+    branches: [ main, dev ]
+
+jobs:
+  coverage:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.10'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install pytest pytest-cov codecov
+        # Install project requirements first
+        pip install -r requirements.txt
+        # Install pytorch_lightning (needed for data module)
+        pip install pytorch-lightning
+        # Install the package in editable mode with data extras
+        pip install -e ".[data,tests]"
+
+    - name: Run tests with coverage
+      run: |
+        pytest tests/ --cov=torch_concepts --cov-report=xml --cov-report=term-missing
+
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v4
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        files: ./coverage.xml
+        flags: unittests
+        name: codecov-umbrella
+        fail_ci_if_error: false
+        verbose: true

.gitignore

@@ -69,9 +69,20 @@ target/
 # pycharm
 .idea/*
 
+# vscode
+.vscode
+
 # lightning logs
 examples/lightning_logs/
 lightning_logs/
 
 # results
 model_results.csv
+
+# data folder (but not torch_concepts/data/)
+data/
+!torch_concepts/data/
+!tests/data/
+
+# conceptarium logs
+outputs/

.readthedocs.yml

@@ -1,8 +1,26 @@
-formats:
-  - none
-requirements_file: requirements.txt
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: doc/conf.py
+
+# Install dependencies
 python:
-  pip_install: true
-  extra_requirements:
-    - tests
-    - docs
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - tests
+        - docs
+        - data
+    - requirements: requirements.txt

CODE_OF_CONDUCT.md

@@ -0,0 +1,24 @@
+# PyC Code of Conduct
+
+## Our Pledge
+We, the PyC Team, are committed to making PyC an open, welcoming, and respectful community. We pledge to provide a harassment-free experience for everyone, regardless of background or identity.
+
+## Our Standards
+Examples of behavior that contribute to a positive environment:
+- Being respectful and constructive.
+- Offering helpful feedback.
+- Showing empathy toward others.
+
+Examples of unacceptable behavior:
+- Harassment or discrimination of any kind.
+- Personal attacks, trolling, or insults.
+- Publishing private information without permission.
+
+## Our Responsibilities
+The PyC Team is responsible for clarifying our standards and taking appropriate actions when behavior violates this Code of Conduct.
+
+## Enforcement
+Instances of unacceptable behavior may be reported to the PyC Team at the project's issue tracker or through direct contact. All complaints will be reviewed and handled confidentially.
+
+## Attribution
+This Code of Conduct is adapted from the Contributor Covenant.

CONTRIBUTING.md

@@ -0,0 +1,86 @@
+# Contributing to PyC
+
+We welcome contributions to PyC! This guide will help you contribute effectively.
+
+Thank you for your interest in contributing! The PyC Team welcomes all contributions, whether small bug fixes or major features.
+
+## Join Our Community
+
+Have questions or want to discuss your ideas? Join our Slack community to connect with other contributors and maintainers!
+
+[![Slack](https://img.shields.io/badge/Slack-Join%20Us-4A154B?style=for-the-badge&logo=slack)](https://join.slack.com/t/pyc-yu37757/shared_invite/zt-3jdcsex5t-LqkU6Plj5rxFemh5bRhe_Q)
+
+## How to Contribute
+
+1. **Fork the repository** - Create your own fork of the PyC repository on GitHub.
+2. **Use the** `dev` **branch** - Write and test your contributions locally on the `dev` branch.
+3. **Create a new branch** - Make a new branch for your specific contribution.
+4. **Make your changes** - Implement your changes with clear, descriptive commit messages.
+5. **Use Gitmoji** - Add emojis to your commit messages using [Gitmoji](https://gitmoji.dev/) for better clarity.
+6. **Write documentation and tests** - Ensure your contributions include appropriate documentation and tests.
+7. **Run all tests** - Make sure all tests pass before submitting your pull request.
+8. **Submit a Pull Request** - Open a PR to the `main` branch describing your changes.
+
+## Development Setup
+
+### Prerequisites
+
+- Python 3.9 or higher
+- PyTorch (latest stable version)
+
+### Installation
+
+Install PyC and its dependencies:
+
+```bash
+pip install pytorch-concepts
+```
+
+For development, you may want to install in editable mode:
+
+```bash
+git clone https://github.com/pyc-team/pytorch_concepts.git
+cd pytorch_concepts
+pip install -e .
+```
+
+## Reporting Issues
+
+If you find a bug or have a feature request, please open an issue on our [GitHub Issues page](https://github.com/pyc-team/pytorch_concepts/issues) using the appropriate issue template.
+
+When reporting issues, please include:
+
+- A clear description of the problem
+- Steps to reproduce the issue
+- Expected vs. actual behavior
+- Your environment (Python version, PyTorch version, OS, etc.)
+
+## Code Style
+
+Please follow these guidelines when contributing code:
+
+- **PEP 8** - Follow [PEP 8](https://pep8.org/) style guidelines for Python code.
+- **Type hints** - Use type hints where appropriate to improve code clarity.
+- **Docstrings** - Write clear docstrings for all public functions and classes.
+- **Tests** - Write tests for new features and bug fixes when possible.
+- **Documentation** - Update documentation to reflect your changes.
+
+## Pull Request Process
+
+1. Ensure your code follows the style guidelines above.
+2. Update the documentation if you've made changes to the API.
+3. Add tests for new functionality.
+4. Make sure all tests pass locally.
+5. Write a clear PR description explaining what changes you made and why.
+6. Link any related issues in your PR description.
+7. Wait for review from the maintainers.
+
+## Thank You!
+
+Every contributor helps make PyC better. We appreciate your time and effort!
+
+Thanks to all our contributors! 🧡
+
+<a href="https://github.com/pyc-team/pytorch_concepts/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=pyc-team/pytorch_concepts" alt="Contributors" />
+</a>

NOTICE

@@ -0,0 +1,13 @@
+Copyright 2025 PyC Team
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.