Merge pull request #13 from huggingface/main

Merge HF

Author: joaopauloschuler

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,26 @@
+---
+name: Bug report
+about: The clearer your bug report, the faster it will be fixed!
+title: "[BUG]"
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**Code to reproduce the error**
+The simplest code snippet that produces your bug.
+
+**Error logs (if any)**
+Provide error logs if there are any.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Packages version:**
+Run `pip freeze | grep smolagents` and paste it here.
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/custom.md

@@ -0,0 +1,10 @@
+---
+name: Custom issue template
+about: Describe this issue template's purpose here.
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,23 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Is this not possible with the current options.**
+Make sure to consider if what you're requesting can be done with current abstractions.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/build_documentation.yml

@@ -20,6 +20,7 @@ jobs:
       commit_sha: ${{ github.sha }}
       package: smolagents
       languages: en
+      notebook_folder: smolagents_doc
       # additional_args: --not_python_module # use this arg if repository is documentation only
     secrets:
       token: ${{ secrets.HUGGINGFACE_PUSH }}

.github/workflows/tests.yml

@@ -34,6 +34,11 @@ jobs:
       # Run all tests separately for individual feedback
       # Use 'if success() || failure()' so that all tests are run even if one failed
       # See https://stackoverflow.com/a/62112985
+      - name: Import tests
+        run: |
+          uv run pytest ./tests/test_import.py
+        if: ${{ success() || failure() }}
+
       - name: Agent tests
         run: |
           uv run pytest ./tests/test_agents.py
@@ -58,14 +63,24 @@ jobs:
           uv run pytest ./tests/test_models.py
         if: ${{ success() || failure() }}
 
+      - name: Memory tests
+        run: |
+          uv run pytest ./tests/test_memory.py
+        if: ${{ success() || failure() }}
+
       - name: Monitoring tests
         run: |
           uv run pytest ./tests/test_monitoring.py
         if: ${{ success() || failure() }}
 
-      - name: Python interpreter tests
+      - name: Local Python executor tests
         run: |
-          uv run pytest ./tests/test_python_interpreter.py
+          uv run pytest ./tests/test_local_python_executor.py
+        if: ${{ success() || failure() }}
+
+      - name: E2B executor tests
+        run: |
+          uv run pytest ./tests/test_e2b_executor.py
         if: ${{ success() || failure() }}
 
       - name: Search tests
@@ -78,6 +93,11 @@ jobs:
           uv run pytest ./tests/test_tools.py
         if: ${{ success() || failure() }}
 
+      - name: Tool validation tests
+        run: |
+          uv run pytest ./tests/test_tool_validation.py
+        if: ${{ success() || failure() }}
+
       - name: Types tests
         run: |
           uv run pytest ./tests/test_types.py
@@ -88,6 +108,11 @@ jobs:
           uv run pytest ./tests/test_utils.py
         if: ${{ success() || failure() }}
 
+      - name: Gradio UI tests
+        run: |
+          uv run pytest ./tests/test_gradio_ui.py
+        if: ${{ success() || failure() }}
+
       - name: Function type hints utils tests
         run: |
           uv run pytest ./tests/test_function_type_hints_utils.py

CONTRIBUTING.md

@@ -33,19 +33,17 @@ However you choose to contribute, please be mindful and respect our
 
 There are several ways you can contribute to smolagents.
 
-* Fix outstanding issues with the existing code.
 * Submit issues related to bugs or desired new features.
 * Contribute to the examples or to the documentation.
+* Fix outstanding issues with the existing code.
 
 > All contributions are equally valuable to the community. 🥰
 
-## Fixing outstanding issues
-
-If you notice an issue with the existing code and have a fix in mind, feel free to [start contributing](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) and open
-a Pull Request!
-
 ## Submitting a bug-related issue or feature request
 
+At any moment, feel welcome to open an issue, citing your exact error traces and package versions if it's a bug.
+It's often even better to open a PR with your proposed fixes/changes!
+
 Do your best to follow these guidelines when submitting a bug-related issue or a feature
 request. It will make it easier for us to come back to you quickly and with good
 feedback.
@@ -89,10 +87,41 @@ We're always looking for improvements to the documentation that make it more cle
 how the documentation can be improved such as typos and any content that is missing, unclear or inaccurate. We'll be 
 happy to make the changes or help you make a contribution if you're interested!
 
+## Fixing outstanding issues
+
+If you notice an issue with the existing code and have a fix in mind, feel free to [start contributing](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) and open
+a Pull Request!
+
+### Making code changes
+
+To install dev dependencies, run:
+```
+pip install -e ".[dev]"
+```
+
+When making changes to the codebase, please check that it follows the repo's code quality requirements by running:
+To check code quality of the source code:
+```
+make quality
+```
+
+If the checks fail, you can run the formatter with:
+```
+make style
+```
+
+And commit the changes.
+
+To run tests locally, run this command:
+```bash
+make test
+```
+</details>
+
 ## I want to become a maintainer of the project. How do I get there?
 
 smolagents is a project led and managed by Hugging Face. We are more than
 happy to have motivated individuals from other organizations join us as maintainers with the goal of helping smolagents
 make a dent in the world of Agents.
 
-If you are such an individual (or organization), please reach out to us and let's collaborate.
+If you are such an individual (or organization), please reach out to us and let's collaborate.