Readme + Docs #10
Readme + Docs #10
Conversation
README.md
Outdated
| @@ -1,16 +1,68 @@ | |||
| # Cleanlab Codex [](https://github.com/cleanlab/cleanlab-codex/actions/workflows/ci.yml) [](https://pypi.org/project/cleanlab-codex) [](https://pypi.org/project/cleanlab-codex) | |||
| <!-- TARGET AUDIENCE: RAG SYSTEM DEVELOPER --> | |||
There was a problem hiding this comment.
Are you going to keep this comment?
There was a problem hiding this comment.
nope will remove it before actually merging!
src/cleanlab_codex/codex_tool.py
Outdated
| @property | ||
| def fallback_answer(self) -> Optional[str]: | ||
| """The fallback answer to use if the Codex project cannot answer the question.""" | ||
| """The fallback answer to use if the Codex project cannot answer the question. This will be returned from by the tool if the Codex project does not have an answer to the question.""" |
There was a problem hiding this comment.
| """The fallback answer to use if the Codex project cannot answer the question. This will be returned from by the tool if the Codex project does not have an answer to the question.""" | |
| """The fallback answer to use if the Codex project cannot answer the question. This will be returned by the tool if the Codex project does not have an answer to the question.""" |
README.md
Outdated
| - **Easy Integration**: Integrate Codex into your RAG/Agentic application with just a few lines of code. | ||
| - **Immediate Impact**: SME responses instantly enhance your AI applications. | ||
|
|
||
| ## How does Codex interact with my AI application? |
There was a problem hiding this comment.
Let's avoid duplication with (planned/WIP) docs, and leave these TODO sections out of the README.
src/cleanlab_codex/codex_tool.py
Outdated
| """Converts the tool to a smolagents tool.""" | ||
| """Converts the tool to a [smolagents tool](https://huggingface.co/docs/smolagents/reference/tools#smolagents.Tool). | ||
|
|
||
| Note: You must have the [`smolagents` library installed](https://github.com/huggingface/smolagents/tree/main?tab=readme-ov-file#quick-demo) to use this method. |
There was a problem hiding this comment.
| Note: You must have the [`smolagents` library installed](https://github.com/huggingface/smolagents/tree/main?tab=readme-ov-file#quick-demo) to use this method. | |
| Note: You must have the [`smolagents` library installed](https://github.com/huggingface/smolagents) to use this method. |
src/cleanlab_codex/types/entry.py
Outdated
| from codex.types.projects.entry_create_params import EntryCreateParams | ||
|
|
||
|
|
||
| class EntryCreate(EntryCreateParams): |
There was a problem hiding this comment.
Is there a lazydocs config that can have it generate useful documentation for this class without us having to manually write a docstring (still, have a problem here that this docstring can get out of sync with the generated EntryCreateParams).
Perhaps a hack like EntryCreate.__doc__ = EntryCreateParams?
If this is too much effort, we can skip it. Also, this might change if we revamp the docs build system (https://github.com/cleanlab/cleanlab-studio-docs/issues/641).
There was a problem hiding this comment.
Figured out a hack to generate the class previews in the docstrings. Seems like that's the part that's most likely to get out of sync. The stainless SDKs don't actually have autogenerated docstrings, so we do need to manually write some documentation for the redefined type classes.
To view API reference docs in help.cleanlab.ai locally, check out
codex-client-reference-improvementsbranch ofcleanlab-studio-docs, runmake install,make update-api-reference, andmake docs.There's some portions that are still WIP, links that need to be added, and things that need to be updated but wanted to get a first pass review on the overall structure and content ASAP.