Fix docs
This commit is contained in:
parent
6331ede9a2
commit
a61e8709d3
2 changed files with 29 additions and 21 deletions
|
|
@ -66,7 +66,7 @@ from great_ai import GreatAI, use_model
|
|||
def type_safe_greeter(your_name: str, model) -> str:
|
||||
return f'Hi {your_name}!'
|
||||
|
||||
assert type_safe_greeter('Andras').output == 'Hi Andras'
|
||||
assert type_safe_greeter('Andras').output == 'Hi Andras!'
|
||||
```
|
||||
|
||||
1. By default, the parameter named `model` will be replaced by the loaded model. This behaviour can be customised by setting the `model_kwarg_name`. This way, even multiple models can be injected into a single function.
|
||||
|
|
@ -82,14 +82,14 @@ If you wish to turn off logging or specify custom validation for your parameters
|
|||
By default, all parameters that are not affected by an explicit [@parameter][great_ai.parameter] or [@use_model][great_ai.use_model] are automatically decorated with [@parameter][great_ai.parameter] when [@GreatAI.create][great_ai.GreatAI.create] is called.
|
||||
|
||||
```python title="greeter_with_validation.py"
|
||||
from great_ai import GreatAI, use_model
|
||||
from great_ai import GreatAI, parameter
|
||||
|
||||
@GreatAI.create
|
||||
@parameter('your_name', disable_logging=True)
|
||||
def type_safe_greeter(your_name: str, model) -> str:
|
||||
def type_safe_greeter(your_name: str) -> str:
|
||||
return f'Hi {your_name}!'
|
||||
|
||||
assert type_safe_greeter('Andras').output == 'Hi Andras'
|
||||
assert type_safe_greeter('Andras').output == 'Hi Andras!'
|
||||
```
|
||||
|
||||
!!! important
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# How to use LargeFiles
|
||||
|
||||
The functions [save_model][great_ai.use_model] and [@use_model][great_ai.use_model] wrap LargeFile instances. Hence, besides configuring [LargeFile](https://great-ai.schmelczer.dev/reference/large-file), users have few reasons to use LargeFiles directly.
|
||||
The functions [save_model][great_ai.save_model] and [@use_model][great_ai.use_model] wrap LargeFile instances. Hence, besides configuring [LargeFile](https://great-ai.schmelczer.dev/reference/large-file), users have few reasons to use LargeFiles directly.
|
||||
|
||||
## Motivation
|
||||
|
||||
|
|
@ -16,12 +16,12 @@ Often, especially when working with data-heavy applications, large files can pro
|
|||
```python
|
||||
from great_ai.large_file import LargeFileS3
|
||||
|
||||
LargeFileS3.configure_credentials({
|
||||
"aws_region_name": "your_region_like_eu-west-2",
|
||||
"aws_access_key_id": "YOUR_ACCESS_KEY_ID",
|
||||
"aws_secret_access_key": "YOUR_VERY_SECRET_ACCESS_KEY",
|
||||
"large_files_bucket_name": "create_a_bucket_and_put_its_name_here",
|
||||
})
|
||||
LargeFileS3.configure_credentials(
|
||||
aws_region_name="your_region_like_eu-west-2",
|
||||
aws_access_key_id="YOUR_ACCESS_KEY_ID",
|
||||
aws_secret_access_key="YOUR_VERY_SECRET_ACCESS_KEY",
|
||||
large_files_bucket_name="create_a_bucket_and_put_its_name_here",
|
||||
)
|
||||
|
||||
# Creates a new version and deletes the older version
|
||||
# leaving the three most recently used intact
|
||||
|
|
@ -44,6 +44,8 @@ Often, especially when working with data-heavy applications, large files can pro
|
|||
The local cache can be configured with these properties:
|
||||
|
||||
```python
|
||||
from pathlib import Path
|
||||
|
||||
LargeFileS3.cache_path = Path('.cache')
|
||||
LargeFileS3.max_cache_size = "30 GB"
|
||||
```
|
||||
|
|
|
|||
Loading…
Reference in a new issue