Skip to content

Update user docs and add FineTune Search and LLM functional tests #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 25, 2023
Merged

Update user docs and add FineTune Search and LLM functional tests #79

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions docs/user/user_doc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,14 +174,21 @@ Using the aiXplain SDK, you can also onboard your dataset into the aiXplain plat

[FineTune](https://aixplain.com/platform/finetune) allows you to customize models by tuning them using your data and enhancing their performance. Set up and start fine-tuning with a few lines of code. Once fine-tuning is complete, the model will be deployed into your assets, ready for you to use.

You can also run this FineTune guide in Google Colab:
For now, we support the following tasks: `translation`, `speech-recognition`, `search` and `text-generation`. We have a guide for each task available on Google Colab:

[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1rVxxZpHzyP4FWn_Rd_j_g8tHU76S3rVT?usp=sharing)
- Translation:
- [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1rVxxZpHzyP4FWn_Rd_j_g8tHU76S3rVT?usp=sharing)
- Speech recognition:
- [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1IwzIKT4li_YZbUHPzlXsugqLz_7g6ov6?usp=sharing)
- Search:
- [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1W56VZuJPm0FilnvEvpo38T92XvZIGDUs?usp=sharing)
- Text generation:
- [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/drive/1DeaOalATM2X9h0d7Uw4jOoT36WfB9nsB?usp=sharing)

### Creating a FineTune


You can use the `FinetuneFactory` to create a FineTune object using the SDK. For now, we support the following tasks: `translation` and `speech-recognition`:
You can use the `FinetuneFactory` to create a FineTune object using the SDK. Here we show an example on how to fine-tune a translation model:

```python
from aixplain.factories import FinetuneFactory, DatasetFactory, ModelFactory
Expand Down
10 changes: 9 additions & 1 deletion tests/functional/finetune/data/finetune_test_run_data.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,16 @@
"model_id": "60ddefae8d38c51c5885eff7",
"dataset_id": "64a81e78ead7e90455bb6aeb"
},
{
{
"model_id": "60ddef908d38c51c5885dd1e",
"dataset_id": "64a8961aead7e90455bb6b62"
},
{
"model_id": "6499cc946eb5633de15d82a1",
"dataset_id": "650d9f3c27e15c66add3bbf4"
},
{
"model_id": "640b517694bf816d35a59125",
"dataset_id": "6501ea64b61fed7fe5976c49"
}
]