Skip to content

ip #26

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.

Sign up for GitHub

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 2 commits into from
Mar 17, 2025
Merged

ip #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e1741e0
refactor: switch api_key -> logging_id for module tracing
denverbaumgartner Mar 17, 2025
e1979ab
refactor: update doc gen eval to use logging_id in document_full_schema
denverbaumgartner Mar 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion graphdoc/graphdoc/eval/doc_generator_eval.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ def forward(self, database_schema: str) -> dict[str, Any]:
trace=True,
client=self.mlflow_helper.mlflow_client,
expirement_name=self.mlflow_experiment_name,
api_key="temp",
logging_id="temp",
)
# TODO: let's decide if this is how we want to handle this in the future.
# Alternatively, we could return the documented schema from forward,
Expand Down
16 changes: 12 additions & 4 deletions graphdoc/graphdoc/modules/doc_generator_module.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -279,13 +279,21 @@ def document_full_schema(
trace: bool = False,
client: Optional[mlflow.MlflowClient] = None,
expirement_name: Optional[str] = None,
api_key: Optional[str] = None,
logging_id: Optional[str] = None,
) -> dspy.Prediction:
"""Given a database schema, parse out the underlying components and document on
a per-component basis.

:param database_schema: The database schema to generate documentation for.
:type database_schema: str
:param trace: Whether to trace the generation.
:type trace: bool
:param client: The mlflow client.
:type client: mlflow.MlflowClient
:param expirement_name: The name of the experiment.
:type expirement_name: str
:param logging_id: The id to use for logging. Maps back to the user request.
:type logging_id: str
:return: The generated documentation.
:rtype: dspy.Prediction

Expand All @@ -296,8 +304,8 @@ def document_full_schema(
raise ValueError("client must be provided if trace is True")
if expirement_name is None:
raise ValueError("expirement_name must be provided if trace is True")
if api_key is None:
raise ValueError("api_key must be provided if trace is True")
if logging_id is None:
raise ValueError("logging_id must be provided if trace is True")

# check that the graphql is valid
try:
Expand All @@ -323,7 +331,7 @@ def document_full_schema(
# TODO: we should have better type handling, but we check at the top
trace_name="document_full_schema",
inputs={"database_schema": database_schema},
attributes={"api_key": api_key},
attributes={"logging_id": logging_id},
)
log.info("created trace: " + str(root_trace))

Expand Down