Comments (2)
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)
- Integrate with Llamaindex HOT 2
- What are the main differences between magentic and declarai? HOT 1
- Cannot specify max_tokens in OpenaiChatModel HOT 1
- @prompt_chain error if response model is Generic HOT 2
- Can this be used with Ollama? HOT 3
- Capability to debug model input/output HOT 1
- Temporary solution for AttributeError: module ‘openai’ has no attribute ‘ChatCompletion’ HOT 1
- Support `gpt-4-vision-preview` HOT 8
- Question: Which repository to pull the package from? HOT 2
- Update prompt to return NULL, but GPT model won't return NULL. HOT 2
- Incorrect product classification HOT 1
- Azure OpenAI not working HOT 2
- Add support to set openai base URL from magentic env variable HOT 2
- Support for reproducible outputs HOT 2
- Is tqdm used in the project? HOT 1
- Basic first example does not work on Ubuntu Python 3.10
- How to pass the OpenAI API key without environment variable? HOT 4
- Would it be possible to expose the `usage` payload of the OpenAI response? HOT 5
- ollama example does not run HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from magentic.