Skip to content

docs: explain how to set document config #1773

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
JohannesMessner merged 2 commits into from
Sep 5, 2023
Merged

docs: explain how to set document config #1773

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ea6e9bd
docs: explain how to set document config
JohannesMessner Sep 5, 2023
d587a6a
test: test config subclassing
JohannesMessner Sep 5, 2023
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
Next Next commit
docs: explain how to set document config 
Signed-off-by: Johannes Messner <[email protected]>
  • Loading branch information
@JohannesMessner
JohannesMessner committed Sep 5, 2023
commit ea6e9bd33453b50bd545c89d0ad85aee319daabf
15 changes: 15 additions & 0 deletions docs/user_guide/representing/first_step.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,21 @@ This representation can be used to [send](../sending/first_step.md) or [store](.

[BaseDoc][docarray.base_doc.doc.BaseDoc] can be nested to represent any kind of data hierarchy.

## Setting a Pydantic `Config` class

Documents support setting a `Config` [like any other Pydantic `BaseModel`](https://docs.pydantic.dev/latest/usage/model_config/).

However, if you set a config, you should inherit from the `BaseDoc` config class:

```python
from docarray import BaseDoc


class MyDoc(BaseDoc):
class Config(BaseDoc.Config):
Copy link

@deepankarm deepankarm Sep 5, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor comment. In pydantic v1, we only had to pass a class Config in the model. It didn't need to be inherited from another config class.

Copy link
Member Author

@JohannesMessner JohannesMessner Sep 5, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, in pydantic that is not needed. But we set some pydantic configs in BaseDoc, so to preserve them, inheritance is needed. We could probably find some magic way around this, but until then this is the safest option imo.

arbitrary_types_allowed = True # just an example setting
```

See also:

* The [next part](./array.md) of the representing section
Expand Down