Skip to content

Commit a04ad18

Browse files
Changed Codex mentions to Cleanlab AI Platform on API pages (#102)
1 parent 7810f29 commit a04ad18

File tree

4 files changed

+13
-13
lines changed

4 files changed

+13
-13
lines changed

src/cleanlab_codex/client.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
"""Client for interacting with Cleanlab Codex."""
1+
"""Codex Client for interacting with the Cleanlab AI Platform. Codex is the API interface to the Cleanlab AI Platform."""
22

33
from __future__ import annotations
44

@@ -15,9 +15,9 @@
1515

1616
class Client:
1717
"""
18-
Client for interacting with Cleanlab Codex. In order to use this client, make sure you have an account at [codex.cleanlab.ai](https://codex.cleanlab.ai).
18+
Codex Client for interacting with the Cleanlab AI Platform. In order to use this client, make sure you have an account at [codex.cleanlab.ai](https://codex.cleanlab.ai).
1919
20-
We recommend using the [Web UI](https://codex.cleanlab.ai) to [set up Codex projects](/codex/web_tutorials/create_project), but you can also use this client to programmatically set up Codex projects.
20+
We recommend using the [Web UI](https://codex.cleanlab.ai) to [set up Cleanlab projects](/codex/web_tutorials/create_project), but you can also use this client to programmatically set up Cleanlab projects.
2121
"""
2222

2323
def __init__(self, api_key: str | None = None, organization_id: Optional[str] = None):
@@ -56,7 +56,7 @@ def get_project(self, project_id: str) -> Project:
5656
return Project(self._client, project_id)
5757

5858
def create_project(self, name: str, description: Optional[str] = None) -> Project:
59-
"""Create a new Codex project. Project will be created in the organization the client is using.
59+
"""Create a new Cleanlab project. Project will be created in the organization the client is using.
6060
6161
Args:
6262
name (str): The name of the project.

src/cleanlab_codex/project.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
"""Module for interacting with a Codex project."""
1+
"""Module for interacting with a Cleanlab project. Codex is the API interface to the Cleanlab AI Platform."""
22

33
from __future__ import annotations
44

@@ -36,9 +36,9 @@ def __str__(self) -> str:
3636

3737

3838
class Project:
39-
"""Represents a Codex project.
39+
"""Represents a project in the Cleanlab AI Platform.
4040
41-
To integrate a Codex project into your RAG/Agentic system, we recommend using the [`Project.validate()` method](/codex/api/python/project#method-validate).
41+
To integrate a Cleanlab project into your RAG/Agentic system, we recommend using the [`Project.validate()` method](/codex/api/python/project#method-validate).
4242
"""
4343

4444
def __init__(self, sdk_client: _Codex, project_id: str, *, verify_existence: bool = True):
@@ -90,7 +90,7 @@ def create(
9090
name: str,
9191
description: str | None = None,
9292
) -> Project:
93-
"""Create a new Codex project. This method is not meant to be used directly. Instead, use the [`create_project`](/codex/api/python/client#method-create_project) method on the `Client` class.
93+
"""Create a new project. This method is not meant to be used directly. Instead, use the [`create_project`](/codex/api/python/client#method-create_project) method on the `Client` class.
9494
9595
Args:
9696
sdk_client (Codex): The Codex SDK client to use to create the project. This client must be authenticated with a user-level API key.

src/cleanlab_codex/types/organization.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
"""Types for Codex organizations."""
1+
"""Types for Cleanlab organizations. Codex is the API interface to the Cleanlab AI Platform."""
22

33
from codex.types.users.myself.user_organizations_schema import (
44
Organization as _Organization,
@@ -11,7 +11,7 @@ class Organization(_Organization): ...
1111

1212

1313
Organization.__doc__ = f"""
14-
Type representing an organization in Codex.
14+
Type representing a Cleanlab organization in the Cleanlab AI Platform.
1515
1616
{generate_class_docstring(_Organization, name=Organization.__name__)}
1717
"""

src/cleanlab_codex/types/project.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
"""Types for Codex projects."""
1+
"""Types for Cleanlab projects. Codex is the API interface to the Cleanlab AI Platform."""
22

33
from codex.types.project_create_params import Config
44

@@ -9,7 +9,7 @@ class ProjectConfig(Config): ...
99

1010

1111
ProjectConfig.__doc__ = f"""
12-
Type representing options that can be configured for a Codex project.
12+
Type representing options that can be configured for a Cleanlab project.
1313
1414
{generate_class_docstring(Config, name=ProjectConfig.__name__)}
1515
---
@@ -19,7 +19,7 @@ class ProjectConfig(Config): ...
1919
Distance threshold used to determine if two questions in a project are similar.
2020
The metric used is cosine distance. Valid threshold values range from 0 (identical vectors) to 1 (orthogonal vectors).
2121
While cosine distance can extend to 2 (opposite vectors), we limit this value to 1 since finding matches that are less similar than "unrelated" (orthogonal)
22-
content would not improve results of the system querying the Codex project.
22+
content would not improve results of the system querying the Cleanlab project.
2323
"""
2424

2525

0 commit comments

Comments
 (0)