Skip to content

Commit

Permalink
Docs will show updated docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
@DoKu88
DoKu88 committed Nov 18, 2024
1 parent d50e4af commit 3fb55b9
Showing 1 changed file with 16 additions and 295 deletions.
311 changes: 16 additions & 295 deletions openapi.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -136,140 +136,16 @@
"deprecated": false
}
},
"/decorators/trace_system_async": {
"post": {
"tags": [
"Generated API"
],
"summary": "trace_system_async",
"description": "Decorator for tracing asynchronous functions.\n\n**Function Signature:** `trace_system_async(origin, event_type, log_result, manage_event, increment_partition, verbose, finetune_step)`\n\n**Return Type:** `Callable`\n\n[View source on GitHub](https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/decorators.py#L246)",
"externalDocs": {
"description": "View source on GitHub",
"url": "https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/decorators.py#L246"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"result": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"deprecated": false
}
},
"/decorators/trace_system": {
"post": {
"tags": [
"Generated API"
],
"summary": "trace_system",
"description": "Decorator that chooses the correct tracing method (sync or _async) based on\nwhether the wrapped function is synchronous or asynchronous.\n\n**Function Signature:** `trace_system(origin, event_type, log_result, manage_event, increment_partition, verbose)`\n\n**Return Type:** `Callable`\n\n[View source on GitHub](https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/decorators.py#L452)",
"externalDocs": {
"description": "View source on GitHub",
"url": "https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/decorators.py#L452"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"result": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"deprecated": false
}
},
"/decorators/track_result": {
"post": {
"tags": [
"Generated API"
],
"summary": "track_result",
"description": "Helper function to track results, including tuple unpacking\n\n**Function Signature:** `track_result(result, tracker, origin)`\n\n[View source on GitHub](https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/decorators.py#L483)",
"externalDocs": {
"description": "View source on GitHub",
"url": "https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/decorators.py#L483"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"result": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"deprecated": false
}
},
"/store/get_or_create_system_trace": {
"post": {
"tags": [
"Generated API"
],
"summary": "get_or_create_system_trace",
"description": "Get or create a SystemTrace for the given system_id.\n\n**Function Signature:** `get_or_create_system_trace(system_id, _already_locked)`\n\n**Return Type:** `SystemTrace`\n\n[View source on GitHub](https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/events/store.py#L21)",
"externalDocs": {
"description": "View source on GitHub",
"url": "https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/events/store.py#L21"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"result": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"deprecated": false
}
},
"/store/increment_partition": {
"/decorators/trace_system_sync": {
"post": {
"tags": [
"Generated API"
],
"summary": "increment_partition",
"description": "Increment the partition index for a system and create new partition element.\n\n**Function Signature:** `increment_partition(system_id)`\n\n**Return Type:** `int`\n\n[View source on GitHub](https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/events/store.py#L47)",
"summary": "trace_system_sync",
"description": "Decorator for tracing synchronous functions.\n\nPurpose is to keep track of inputs and outputs for compute steps for sync functions.\n\n**Function Signature:** `trace_system_sync(origin, event_type, log_result, manage_event, increment_partition, verbose, finetune_step)`\n\n**Return Type:** `Callable`\n\n[View source on GitHub](https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/decorators.py#L45)",
"externalDocs": {
"description": "View source on GitHub",
"url": "https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/events/store.py#L47"
"url": "https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/decorators.py#L45"
},
"responses": {
"200": {
Expand All @@ -291,171 +167,16 @@
"deprecated": false
}
},
"/store/add_event": {
"post": {
"tags": [
"Generated API"
],
"summary": "add_event",
"description": "Add an event to the appropriate partition of the system trace.\n\n**Function Signature:** `add_event(system_id, event)`\n\n[View source on GitHub](https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/events/store.py#L75)",
"externalDocs": {
"description": "View source on GitHub",
"url": "https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/events/store.py#L75"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"result": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"deprecated": false
}
},
"/store/get_system_traces": {
"post": {
"tags": [
"Generated API"
],
"summary": "get_system_traces",
"description": "Get all system traces.\n\n**Function Signature:** `get_system_traces(No arguments)`\n\n**Return Type:** `List[SystemTrace]`\n\n[View source on GitHub](https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/events/store.py#L122)",
"externalDocs": {
"description": "View source on GitHub",
"url": "https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/events/store.py#L122"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"result": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"deprecated": false
}
},
"/store/end_all_active_events": {
"post": {
"tags": [
"Generated API"
],
"summary": "end_all_active_events",
"description": "End all active events and store them.\n\n**Function Signature:** `end_all_active_events(No arguments)`\n\n[View source on GitHub](https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/events/store.py#L129)",
"externalDocs": {
"description": "View source on GitHub",
"url": "https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/events/store.py#L129"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"result": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"deprecated": false
}
},
"/store/get_system_traces_json": {
"post": {
"tags": [
"Generated API"
],
"summary": "get_system_traces_json",
"description": "Get all system traces as JSON.\n\n**Function Signature:** `get_system_traces_json(No arguments)`\n\n**Return Type:** `str`\n\n[View source on GitHub](https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/events/store.py#L160)",
"externalDocs": {
"description": "View source on GitHub",
"url": "https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/events/store.py#L160"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"result": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"deprecated": false
}
},
"/manage/get_current_event": {
"post": {
"tags": [
"Generated API"
],
"summary": "get_current_event",
"description": "Get the current active event of the specified type.\nRaises ValueError if no such event exists.\n\n**Function Signature:** `get_current_event(event_type)`\n\n**Return Type:** `'Event'`\n\n[View source on GitHub](https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/events/manage.py#L14)",
"externalDocs": {
"description": "View source on GitHub",
"url": "https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/events/manage.py#L14"
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"result": {
"type": "string"
}
},
"type": "object"
}
}
}
}
},
"deprecated": false
}
},
"/manage/set_current_event": {
"/decorators/trace_system_async": {
"post": {
"tags": [
"Generated API"
],
"summary": "set_current_event",
"description": "Set the current event, ending any existing events of the same type.\nIf event is None, it clears the current event of that type.\n\n**Function Signature:** `set_current_event(event)`\n\n[View source on GitHub](https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/events/manage.py#L25)",
"summary": "trace_system_async",
"description": "Decorator for tracing asynchronous functions.\n\nPurpose is to keep track of inputs and outputs for compute steps for _async functions.\n\n**Function Signature:** `trace_system_async(origin, event_type, log_result, manage_event, increment_partition, verbose, finetune_step)`\n\n**Return Type:** `Callable`\n\n[View source on GitHub](https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/decorators.py#L250)",
"externalDocs": {
"description": "View source on GitHub",
"url": "https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/events/manage.py#L25"
"url": "https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/decorators.py#L250"
},
"responses": {
"200": {
Expand All @@ -477,16 +198,16 @@
"deprecated": false
}
},
"/manage/end_event": {
"/decorators/trace_system": {
"post": {
"tags": [
"Generated API"
],
"summary": "end_event",
"description": "End the current event and store it.\n\n**Function Signature:** `end_event(event_type)`\n\n**Return Type:** `Optional[Event]`\n\n[View source on GitHub](https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/events/manage.py#L108)",
"summary": "trace_system",
"description": "Decorator that chooses the correct tracing method (sync or _async) based on\nwhether the wrapped function is synchronous or asynchronous.\n\nPurpose is to keep track of inputs and outputs for compute steps for both sync and _async functions.\n\n**Function Signature:** `trace_system(origin, event_type, log_result, manage_event, increment_partition, verbose)`\n\n**Return Type:** `Callable`\n\n[View source on GitHub](https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/decorators.py#L459)",
"externalDocs": {
"description": "View source on GitHub",
"url": "https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/events/manage.py#L108"
"url": "https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/decorators.py#L459"
},
"responses": {
"200": {
Expand All @@ -508,16 +229,16 @@
"deprecated": false
}
},
"/scope/event_scope": {
"/decorators/track_result": {
"post": {
"tags": [
"Generated API"
],
"summary": "event_scope",
"description": "Context manager for creating and managing events.\n\nUsage:\n with event_scope(\"my_event_type\"):\n # do stuff\n\n**Function Signature:** `event_scope(event_type)`\n\n[View source on GitHub](https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/events/scope.py#L10)",
"summary": "track_result",
"description": "Helper function to track results, including tuple unpacking\n\n**Function Signature:** `track_result(result, tracker, origin)`\n\n[View source on GitHub](https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/decorators.py#L492)",
"externalDocs": {
"description": "View source on GitHub",
"url": "https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/events/scope.py#L10"
"url": "https://github.com/synth-laboratories/synth-sdk/blob/main/synth_sdk/tracing/decorators.py#L492"
},
"responses": {
"200": {
Expand Down

0 comments on commit 3fb55b9

Please sign in to comment.