Skip to content

refactor: reorganize logger and formatter documentation structure #1310

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Apr 28, 2025
1 change: 1 addition & 0 deletions docs/docs/api/base/swarmauri_base/agents/AgentBase.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
::: swarmauri_base.agents.AgentBase.AgentBase
options.extra:
show_inheritance: true

6 changes: 0 additions & 6 deletions docs/docs/api/base/swarmauri_base/logger/LoggerBase.md

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Class `swarmauri_base.logger_formatters.FormatterBase.FormatterBase`

::: swarmauri_base.logger_formatters.FormatterBase.FormatterBase
options.extra:
show_inheritance: true

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Class `swarmauri_base.logger_handlers.HandlerBase.HandlerBase`

::: swarmauri_base.logger_handlers.HandlerBase.HandlerBase
options.extra:
show_inheritance: true

6 changes: 6 additions & 0 deletions docs/docs/api/base/swarmauri_base/loggers/LoggerBase.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Class `swarmauri_base.loggers.LoggerBase.LoggerBase`

::: swarmauri_base.loggers.LoggerBase.LoggerBase
options.extra:
show_inheritance: true

File renamed without changes.
6 changes: 0 additions & 6 deletions docs/docs/api/core/swarmauri_core/logger/ILogger.md

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Class `swarmauri_core.logger_formatters.IFormatter.IFormatter`

::: swarmauri_core.logger_formatters.IFormatter.IFormatter
options.extra:
show_inheritance: true

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Class `swarmauri_core.logger_handlers.IHandler.IHandler`

::: swarmauri_core.logger_handlers.IHandler.IHandler
options.extra:
show_inheritance: true

6 changes: 6 additions & 0 deletions docs/docs/api/core/swarmauri_core/loggers/ILogger.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Class `swarmauri_core.loggers.ILogger.ILogger`

::: swarmauri_core.loggers.ILogger.ILogger
options.extra:
show_inheritance: true

6 changes: 0 additions & 6 deletions docs/docs/api/core/swarmauri_core/tool_llms/IPredict.md

This file was deleted.

6 changes: 6 additions & 0 deletions docs/docs/api/core/swarmauri_core/tool_llms/IToolPredict.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Class `swarmauri_core.tool_llms.IToolPredict.IToolPredict`

::: swarmauri_core.tool_llms.IToolPredict.IToolPredict
options.extra:
show_inheritance: true

This file was deleted.

This file was deleted.

6 changes: 6 additions & 0 deletions docs/docs/api/standard/swarmauri_standard/loggers/Logger.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Class `swarmauri_standard.loggers.Logger.Logger`

::: swarmauri_standard.loggers.Logger.Logger
options.extra:
show_inheritance: true

6 changes: 0 additions & 6 deletions docs/docs/api/standard/swarmauri_standard/logging/Logger.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Class `swarmauri_standard.tool_llms.DeepInfraToolModel.DeepInfraToolModel`

::: swarmauri_standard.tool_llms.DeepInfraToolModel.DeepInfraToolModel
options.extra:
show_inheritance: true

Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Class `swarmauri_standard.tool_llms.ToolLLM.ToolLLM`

::: swarmauri_standard.tool_llms.ToolLLM.ToolLLM
options.extra:
show_inheritance: true

File renamed without changes.
33 changes: 16 additions & 17 deletions docs/docs/guide/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,10 @@ pip install swarmauri
```

!!! info "Installation Options"
For specific versions or development builds:
```bash
# Install specific version
pip install swarmauri==1.2.3

For specific versions or development builds:
```bash # Install specific version
pip install swarmauri==1.2.3

# Install from GitHub (latest development version)
pip install git+https://github.com/swarmauri/swarmauri-sdk.git
```
Expand Down Expand Up @@ -49,11 +48,7 @@ If you encounter `ModuleNotFoundError`:
pip list | grep swarmauri
```

!!! warning "Common Import Error Causes"
- Package not installed correctly
- Virtual environment not activated
- Package installed in a different Python environment
- Package name misspelled in the import statement
!!! warning "Common Import Error Causes" - Package not installed correctly - Virtual environment not activated - Package installed in a different Python environment - Package name misspelled in the import statement

### Version Conflicts

Expand All @@ -69,12 +64,12 @@ pip install swarmauri
```

!!! tip "Dependency Isolation"
Consider using tools like Poetry or pipenv for better dependency management. These tools create lockfiles that ensure consistent environments across different machines.
Consider using tools like Poetry or pipenv for better dependency management. These tools create lockfiles that ensure consistent environments across different machines.

```bash
# Using Poetry
poetry add swarmauri

# Using pipenv
pipenv install swarmauri
```
Expand All @@ -94,8 +89,8 @@ sudo apt install build-essential # For Ubuntu/Debian
```

??? danger "Installation Troubleshooting"
If you encounter persistent installation issues:
If you encounter persistent installation issues:

1. Make sure your pip is up to date: `pip install --upgrade pip`
2. Check if you have sufficient privileges (try using `sudo` on Linux/Mac or run as administrator on Windows)
3. If you're behind a corporate firewall, you may need to configure pip to use an HTTPS proxy
Expand Down Expand Up @@ -140,13 +135,13 @@ print(response)
```

!!! info "Available Tools"
Swarmauri SDK offers a variety of built-in tools including:
Swarmauri SDK offers a variety of built-in tools including:

- `CalculatorTool`: For mathematical operations
- `RequestsTool`: For HTTP requests
- `CodeExtractorTool`: For code extraction
- `CodeInterpreterTool`: For python code execution

You can also create custom tools by extending the `ToolBase` class.

### How do I create an AI assistant?
Expand Down Expand Up @@ -174,6 +169,7 @@ print(response)
response = agent.exec("Can you explain it in simpler terms?")
print(response)
```

### How do I handle large datasets?

- **Chunking**: Break down large datasets into smaller chunks for processing.
Expand Down Expand Up @@ -232,3 +228,6 @@ If you need further assistance:
1. Check our API Documentation
2. Visit our [GitHub Issues](https://github.com/swarmauri/swarmauri-sdk/issues)
3. Join our [Discord Community](https://discord.gg/swarmauri)

!!! info "Community Support"
Our community is active and ready to help with any questions you might have. Don't hesitate to reach out if you're facing challenges with Swarmauri SDK.
10 changes: 5 additions & 5 deletions docs/docs/guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Welcome to Swarmauri guides! This section contains practical tutorials and how-t

- **[Installation Guide](installation.md)** - Step-by-step instructions for setting up Swarmauri SDK
- **[Usage Guide](usage.md)** - Learn how to use core Swarmauri features
- **[Courses](course/1.md)** - Structured learning paths for different skill levels
- **[Courses](courses.md)** - Structured learning paths for different skill levels
- **[FAQ](faq.md)** - Answers to frequently asked questions

## Learning Paths
Expand All @@ -21,15 +21,15 @@ Choose the path that fits your needs:

### 1. Beginners

Start with the **[Installation Guide](installation.md)** followed by the **[Entry Course](course/1.md)**. This path introduces core concepts without assuming prior AI development experience.
Start with the **[Installation Guide](installation.md)** followed by the **[Entry Course](courses.md)**. This path introduces core concepts without assuming prior AI development experience.

### 2. AI/ML Practitioners

Begin with **[Installation Guide](installation.md)** and jump straight to the **[Generative AI Course](course/2.md)**. This path focuses on using Swarmauri with existing AI/ML knowledge.
Begin with **[Installation Guide](installation.md)** and jump straight to the **[Generative AI Course](courses.md)**. This path focuses on using Swarmauri with existing AI/ML knowledge.

### 3. Tool Developers

After installation, explore the **[Tool Development Course](course/3.md)**. This path is ideal if you want to extend Swarmauri with custom components.
After installation, explore the **[Tool Development Course](courses.md)**. This path is ideal if you want to extend Swarmauri with custom components.

!!! warning "Prerequisites"
The Tool Development path assumes familiarity with Python development practices, including package management, testing, and object-oriented programming concepts.
Expand All @@ -52,7 +52,7 @@ If this is your first time using Swarmauri, we recommend:

1. Install the SDK using the [Installation Guide](installation.md)
2. Follow the basic examples in the [Usage Guide](usage.md)
3. Explore more advanced concepts in our [Courses](course/1.md)
3. Explore more advanced concepts in our [Courses](courses.md)

!!! note "Community Support"
Need help? Visit our [community resources](../home/help.md) or check the [FAQ](faq.md). Our active community is ready to assist with any questions you might have.
12 changes: 6 additions & 6 deletions docs/docs/home/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,19 +132,19 @@ print(swarmauri.__version__)

After installation:

1. Check out our [Quickstart Guide](../guide/quickstart.md)
2. Review [API Documentation](../api/index.md)
3. Try our [Examples](../examples/index.md)
4. Join our [Community](../community/index.md)
1. Check out our [Quickstart Guide](../guide/usage.md)
2. Review [API Documentation](../api/concepts.md)
3. Try our [Courses](../guide/courses.md)
4. Join our [Community](https://discord.gg/swarmauri)

!!! tip "Getting Started"
The [Quickstart Guide](../guide/quickstart.md) is the best place to begin your journey with Swarmauri SDK.
The [Quickstart Guide](../guide/usage.md) is the best place to begin your journey with Swarmauri SDK.

## Getting Help

If you run into issues:

1. Check our [FAQ](../faq.md)
1. Check our [FAQ](../guide/faq.md)
2. Visit our [GitHub Issues](https://github.com/swarmauri/swarmauri-sdk/issues)
3. Join our [Discord Community](https://discord.gg/swarmauri)

Expand Down
8 changes: 4 additions & 4 deletions docs/docs/home/why_use_swarmauri.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,8 @@ Build AI agents that can use tools to accomplish tasks:
- **Jupyter notebook tools** for data science workflows
- **Custom tools** that you can easily build and integrate

!!! tip "Custom Tools"
Creating your own tools is straightforward with Swarmauri. Extend the `ToolBase` class, register it with `@ComponentBase.register_type`, and implement the `__call__` method. See the [Custom Components](../guide/usage.md#creating-custom-components) section for examples.
???+ tip "Custom Tools"
Creating your own tools is straightforward with Swarmauri. Extend the `ToolBase` class, register it with `@ComponentBase.register_type`, and implement the `__call__` method. See the [Custom Components](../guide/usage.md#creating-custom-components) section for examples.

### Data Processing

Expand Down Expand Up @@ -357,8 +357,8 @@ Discover how easy it is to build with Swarmauri:

- [Installation Guide](installation.md) - Get set up with Swarmauri SDK
- [Quick Start Tutorial](../guide/usage.md) - Build your first AI application
- [Examples Gallery](../examples/index.md) - Explore example projects
- [API Reference](../api/index.md) - Dive into detailed documentation
- [ Courses ](../guide/courses.md) - Explore our Courses
- [API Reference](../api/concepts.md) - Dive into detailed documentation

Or jump right in with a simple example:

Expand Down
6 changes: 3 additions & 3 deletions docs/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -288,11 +288,11 @@ Need help? Have a feature suggestion? Join the Swarmauri community:

Here are some recommended next steps to continue your journey with Swarmauri SDK:

1. **Explore the Tutorials**: Check out our [step-by-step tutorials](../tutorials/index.md)
2. **Read the API Documentation**: Dive into our [detailed API reference](../api/index.md)
1. **Explore the Courses**: Check out our [step-by-step courses](./guide/courses.md)
2. **Read the API Documentation**: Dive into our [detailed API reference](./api/concepts.md)
3. **Join the Community**: Connect with other developers in our [Discord server](https://discord.gg/swarmauri)
4. **Contribute**: Learn how to [contribute to the project](./home/contribute.md)
5. **Stay Updated**: Follow our [blog](../blog/index.md) for the latest updates
5. **Stay Updated**: Follow our [blog](./blog/index.md) for the latest updates

---

Expand Down
Loading