> For the complete documentation index, see [llms.txt](https://docs.shimoku.com/dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.shimoku.com/dev/releases/2022/v.0.10.md).

# v.0.10

{% hint style="danger" %}
This version has been deprecated. If used with the current API version it can produce unexpected behaviour or errors.
{% endhint %}

{% hint style="danger" %}
The package shimoku-api-python is no longer maintained
{% endhint %}

{% hint style="info" %}
To get the new version  :gift::gift::gift:
{% endhint %}

```
pip install --upgrade shimoku-api-python
pip install --upgrade shimoku-components-catalog
```

{% hint style="info" %}
This version brings **Machine Learning** features through our API by the first time!!
{% endhint %}

### Fixes

* For readability, renamed `s.file.*` by `s.io.*`:&#x20;

Before: `s.file.get_dataframe(...)`&#x20;

Now: `s.io.get_dataframe(...)`

* Fixed IO for large dataframes now you can POST and GET dataframes of large sizes without size limit.
* Fix path and subpaths. Now Apps with multiple words can be sorted too: `s.plt.set_apps_orders()` and `s.plt.set_sub_path_orders()`&#x20;
* Fixes in the default look\&feel of different charts and with new features to see data, download image, zoom in and out and change chart type:

  * Heatmap `s.plt.heatmap()`

  <figure><img src="/files/mlU9DgnGBpWFN5e610Ci" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/6Cx1tCLHiuHmLs2brj9Q" alt=""><figcaption></figcaption></figure>

* Barchart `s.plt.bar()` and Linechart `s.plt.line()`&#x20;

<figure><img src="/files/JlKHwNH5ssdQf1aODiKx" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/cLg79g3iJR1CMp9H29L9" alt=""><figcaption></figcaption></figure>

### Improvements

* Improvements in the Input Forms look\&feel

<figure><img src="/files/hlBmztMEJaQl4QIh4Kvo" alt=""><figcaption></figcaption></figure>

* Easier to initialize the Shimoku Client

```python
import shimoku_api_python as Shimoku

# Still allowed
s = Shimoku.Client(
    config={'access_token': api_key},    
    universe_id=universe_id,    
    environment=environment
)

# Easier
s = Shimoku.Client(
    access_token=api_key,
    universe_id=universe_id,    
    environment=environment
)
```

* Added IO methods for Machine Learning models:

```python
from sklearn import svm
from sklearn import datasets

clf = svm.SVC()
X, y = datasets.load_iris(return_X_y=True)
clf.fit(X, y)

s.io.post_ai_model(
    business_id=business_id,
    app_name='test',
    model_name='model-object-test',
    model=clf,
)

model = s.io.get_ai_model(
    business_id=business_id,
    app_name='test',
    model_name='model-object-test',
)
```

### New <a href="#refactor" id="refactor"></a>

* Added method to clear a whole business (tabula rasa) `shimoku.plt.clear_business()`

Before

<figure><img src="/files/c9x0SfzidKVQQe7T20A1" alt=""><figcaption></figcaption></figure>

```
s.plt.clear_business()
```

<figure><img src="/files/QMdARFfMlrjgJQtiCppp" alt=""><figcaption></figcaption></figure>

* Added method to retrieve input forms data

<figure><img src="/files/dJIUTsAwek3jBSx1nj83" alt=""><figcaption></figcaption></figure>

```
input_data: List[Dict] = s.plt.get_input_forms(menu_path='test/input-form')
```

![](/files/yGSw3QbdVbjf51ndzPNm)

### Machine Learning!

* **AI** for Machine Learning features. Now users can use Shimoku's Machine Learning from the SDK just passing a test dataframe and specifying the Model endpoint (ask to Shimoku about what endpoints are available). You can decide whether to add Explainability or not to the predictions

```python
df_pred, df_error = s.ai.predict_categorical(
    df_test=df_test_fail,
    model_endpoint=model_endpoint,
    explain=False,
)
```

Also predictive tables have been added that create a table with the prediction

```python
target_column: str = 'NRO_POL'
column_to_predict: str = 'churn_probability'
menu_path: str = 'AI/Churn'
order: int = 0

s.ai.predictive_table(
   df_test=df_test,
   model_endpoint=model_endpoint,    
   target_column=target_column,
   column_to_predict=column_to_predict,  
   prediction_type='categorical',
   explain=True,  
   menu_path=menu_path, order=order,    
   add_filter_by_column_to_predict=False,
   add_search_by_target_column=True,
   extra_filter_columns=None,
   extra_search_columns=None
)
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.shimoku.com/dev/releases/2022/v.0.10.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
