Giter Club home page Giter Club logo

Comments (2)

jackmpcollins avatar jackmpcollins commented on May 18, 2024

Hi @mnicstruwig , inspect.getdoc is used internally so changing the .__doc__ attribute works for the docstring, as in your workaround. For the annotations, if you use the functools.wraps decorator then the annotation information can be determined correctly (I guess this must be due to the .__wrapped__ attribute it adds).

from functools import wraps


def use_custom_docstring(docstring: str):
    def decorator(func):
        @wraps(func)
        def wrapper(*args, **kwargs):
            return func(*args, **kwargs)
        wrapper.__doc__ = docstring
        return wrapper
    return decorator

Here's the code I used to check the produced schemas

from magentic.chat_model.function_schema import FunctionCallFunctionSchema

def plus(a: int, b: int) -> int:
    """Original docstring"""
    return a + b

s = FunctionCallFunctionSchema(plus)
print()
print(s.description)
print(s.parameters)

plus_with_new_docstring = use_custom_docstring("new docstring")(plus)

s = FunctionCallFunctionSchema(plus_with_new_docstring)
print()
print(s.description)
print(s.parameters)

You could achieve a similar API to what you propose by using a regular function rather than a decorator. This would be my preferred solution for the moment - maybe I should include it in magentic as a helper function.

from functools import wraps


def use_custom_docstring(func, docstring: str):
    @wraps(func)
    def wrapper(*args, **kwargs):
        return func(*args, **kwargs)
    wrapper.__doc__ = docstring
    return wrapper

# usage
@prompt(
    PROMPT,
    functions=[use_custom_docstring(my_function, "my function description")],
    model=OpenaiChatModel(model="gpt-4-1106-preview"),
)
def answer_question(world_state: str, question_id: str) -> str:
    ...

I hope that works for you. Thanks for using the package!

from magentic.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.