Skip to content
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

Document the module system for extensions #88

Open
msoedov opened this issue Jan 16, 2025 · 2 comments
Open

Document the module system for extensions #88

msoedov opened this issue Jan 16, 2025 · 2 comments
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@msoedov
Copy link
Owner

msoedov commented Jan 16, 2025

The task is to document the interface of class Module in the docs and README, for example:

https://github.com/msoedov/agentic_security/blob/main/agentic_security/probe_data/modules/garak_tool.py#L22-L70

The same interface is used in other modules directory

Ideally, it is to create an abstract interface and inherit all classes from it.

from typing import Protocol, List, Dict, Any, AsyncGenerator
import asyncio

class ModuleProtocol(Protocol):
    prompt_groups: List[Any]
    tools_inbox: asyncio.Queue
    opts: Dict[str, Any]

    async def apply(self) -> AsyncGenerator[str, None]:
        ...
@msoedov msoedov added help wanted Extra attention is needed good first issue Good for newcomers labels Jan 16, 2025
Repository owner deleted a comment from codeautopilot bot Jan 16, 2025
@Praveenk8051
Copy link
Contributor

Praveenk8051 commented Jan 22, 2025

Hi @msoedov ,
I would like to start from here. Can you give more desciptions and assign it to me ?
Hope its ok to connect with you if i don't understand

@msoedov
Copy link
Owner Author

msoedov commented Jan 22, 2025

Hi @Praveenk8051 Thx for asking this question. Updated

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants