Skip to content

Commit e69f1d9

Browse files
committed
update docs
1 parent a7b5a6d commit e69f1d9

File tree

5 files changed

+517
-28
lines changed

5 files changed

+517
-28
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ install-uv:
3434

3535
compile:
3636
# install extra dev group
37-
uv pip compile pyproject.toml -o requirements.txt --cache-dir .uv_cache
37+
uv pip compile pyproject.toml -o requirements.txt --extra dev --cache-dir .uv_cache
3838

3939
install:
4040
uv pip sync requirements.txt --cache-dir .uv_cache

md-docs/api/python/client.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,8 @@ Project ID Name
267267
.create_task(
268268
project_id: str, name: str, tags: list[str], task_type: TaskType,
269269
data_structure: DataStructure, cost_info: (TaskCostInfoUnion|None) = None,
270-
optional_target: bool = False, text_language: (TextLanguage|None) = None
270+
optional_target: bool = False, text_language: (TextLanguage|None) = None,
271+
positive_class: (str|int|bool|None) = None
271272
)
272273
```
273274

@@ -296,6 +297,8 @@ Create a task inside the project.
296297
data without considering the actual target
297298
* **text_language** : required for NLP tasks, it specifies the
298299
language used in the task.
300+
* **positive_class** : required for binary classification tasks,
301+
it specifies the positive class of the target.
299302

300303

301304
**Returns**

md-docs/api/python/models.md

Lines changed: 37 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -128,21 +128,16 @@ topic_endpoint
128128
----
129129

130130

131-
## ClassificationTaskCostInfo
131+
## BinaryClassificationTaskCostInfo
132132
```python
133-
ClassificationTaskCostInfo()
133+
BinaryClassificationTaskCostInfo()
134134
```
135135

136136

137137
---
138-
Regression cost info is expressed in two terms:
139-
- cost due to overestimation
140-
- cost due to underestimation
141-
142-
Fields:
143-
currency
144-
false_positive_cost
145-
false_negative_cost
138+
Binary classification cost info is expressed in two terms:
139+
- cost of false positive
140+
- cost of false negative
146141

147142
----
148143

@@ -164,10 +159,13 @@ Column base model
164159
* **is_nullable** : bool
165160
* **data_type** : DataType
166161
* **predicted_target** : Optional[str] = None
167-
* **possible_values** : Optional[List] = None
162+
* **possible_values** : Optional[list[str | int | bool]] = None
168163
* **model_id** : Optional[str] = None
169-
* **dims** : Optional[Tuple[int]] = None
170-
it is manadatory when data_type is Array
164+
* **dims** : Optional[tuple[int]] = None
165+
it is mandatory when data_type is Array
166+
* **classes_names** : Optional[list[str]] = None
167+
it is mandatory when the column is the target
168+
in multilabel classification tasks
171169

172170

173171
----
@@ -602,6 +600,32 @@ Base model to define model item
602600
----
603601

604602

603+
## MulticlassClassificationTaskCostInfo
604+
```python
605+
MulticlassClassificationTaskCostInfo()
606+
```
607+
608+
609+
---
610+
Multiclass classification cost info is expressed in terms of
611+
the misclassification costs for each class
612+
613+
----
614+
615+
616+
## MultilabelClassificationTaskCostInfo
617+
```python
618+
MultilabelClassificationTaskCostInfo()
619+
```
620+
621+
622+
---
623+
Multilabel classification cost info is expressed in terms of
624+
false positive and false negative costs for each class
625+
626+
----
627+
628+
605629
## Project
606630
```python
607631
Project()

pyproject.toml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,19 @@ dependencies = [
1919
"mkdocs-glightbox>=0.3.4",
2020
"mkdocs-table-reader-plugin>=2.0.1",
2121
]
22+
23+
[project.optional-dependencies]
24+
dev = [
25+
"ml3-platform-sdk @ file://${PROJECT_ROOT}/../ml3-platform-sdk",
26+
"polars>=0.19.3",
27+
"scikit-learn",
28+
"torch==2.2.0",
29+
"torchvision==0.17.0",
30+
"transformers[torch]",
31+
"datasets==2.15.0",
32+
"sentence-transformers",
33+
"evaluate",
34+
"pillow",
35+
"requests",
36+
"jupyter",
37+
]

0 commit comments

Comments
 (0)