# {py:mod}`arelle.ModelRelationshipSet`

```{py:module} arelle.ModelRelationshipSet
```

```{autodoc2-docstring} arelle.ModelRelationshipSet
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`_LangLabels <arelle.ModelRelationshipSet._LangLabels>`
  - ```{autodoc2-docstring} arelle.ModelRelationshipSet._LangLabels
    :summary:
    ```
* - {py:obj}`ModelRelationshipSet <arelle.ModelRelationshipSet.ModelRelationshipSet>`
  - ```{autodoc2-docstring} arelle.ModelRelationshipSet.ModelRelationshipSet
    :summary:
    ```
````

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`create <arelle.ModelRelationshipSet.create>`
  - ```{autodoc2-docstring} arelle.ModelRelationshipSet.create
    :summary:
    ```
* - {py:obj}`ineffectiveArcs <arelle.ModelRelationshipSet.ineffectiveArcs>`
  - ```{autodoc2-docstring} arelle.ModelRelationshipSet.ineffectiveArcs
    :summary:
    ```
* - {py:obj}`baseSetRelationship <arelle.ModelRelationshipSet.baseSetRelationship>`
  - ```{autodoc2-docstring} arelle.ModelRelationshipSet.baseSetRelationship
    :summary:
    ```
* - {py:obj}`_view_util_attr <arelle.ModelRelationshipSet._view_util_attr>`
  - ```{autodoc2-docstring} arelle.ModelRelationshipSet._view_util_attr
    :summary:
    ```
* - {py:obj}`__getattr__ <arelle.ModelRelationshipSet.__getattr__>`
  - ```{autodoc2-docstring} arelle.ModelRelationshipSet.__getattr__
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`_ <arelle.ModelRelationshipSet._>`
  - ```{autodoc2-docstring} arelle.ModelRelationshipSet._
    :summary:
    ```
* - {py:obj}`USING_EQUIVALENCE_KEY <arelle.ModelRelationshipSet.USING_EQUIVALENCE_KEY>`
  - ```{autodoc2-docstring} arelle.ModelRelationshipSet.USING_EQUIVALENCE_KEY
    :summary:
    ```
* - {py:obj}`NoneType <arelle.ModelRelationshipSet.NoneType>`
  - ```{autodoc2-docstring} arelle.ModelRelationshipSet.NoneType
    :summary:
    ```
* - {py:obj}`_DEPRECATIONS <arelle.ModelRelationshipSet._DEPRECATIONS>`
  - ```{autodoc2-docstring} arelle.ModelRelationshipSet._DEPRECATIONS
    :summary:
    ```
````

### API

````{py:data} _
:canonical: arelle.ModelRelationshipSet._
:type: arelle.typing.TypeGetText
:value: >
   None

```{autodoc2-docstring} arelle.ModelRelationshipSet._
```

````

````{py:data} USING_EQUIVALENCE_KEY
:canonical: arelle.ModelRelationshipSet.USING_EQUIVALENCE_KEY
:value: >
   'intern(...)'

```{autodoc2-docstring} arelle.ModelRelationshipSet.USING_EQUIVALENCE_KEY
```

````

````{py:data} NoneType
:canonical: arelle.ModelRelationshipSet.NoneType
:value: >
   'type(...)'

```{autodoc2-docstring} arelle.ModelRelationshipSet.NoneType
```

````

````{py:function} create(modelXbrl: arelle.ModelXbrl.ModelXbrl, arcrole: tuple[str, ...] | str, linkrole: tuple[str, ...] | str | None = None, linkqname: arelle.ModelValue.QName | None = None, arcqname: arelle.ModelValue.QName | None = None, includeProhibits: bool = False) -> ModelRelationshipSet
:canonical: arelle.ModelRelationshipSet.create

```{autodoc2-docstring} arelle.ModelRelationshipSet.create
```
````

````{py:function} ineffectiveArcs(baseSetModelLinks: list[arelle.ModelDtsObject.ModelLink | arelle.PrototypeDtsObject.LinkPrototype], arcrole: tuple[str, ...] | str, arcqname: arelle.ModelValue.QName | None = None) -> list[arelle.ModelDtsObject.ModelRelationship]
:canonical: arelle.ModelRelationshipSet.ineffectiveArcs

```{autodoc2-docstring} arelle.ModelRelationshipSet.ineffectiveArcs
```
````

````{py:function} baseSetRelationship(arcElement: arelle.ModelObject.ModelObject) -> arelle.ModelDtsObject.ModelRelationship | None
:canonical: arelle.ModelRelationshipSet.baseSetRelationship

```{autodoc2-docstring} arelle.ModelRelationshipSet.baseSetRelationship
```
````

`````{py:class} _LangLabels
:canonical: arelle.ModelRelationshipSet._LangLabels

```{autodoc2-docstring} arelle.ModelRelationshipSet._LangLabels
```

````{py:attribute} lang
:canonical: arelle.ModelRelationshipSet._LangLabels.lang
:type: str
:value: >
   None

```{autodoc2-docstring} arelle.ModelRelationshipSet._LangLabels.lang
```

````

````{py:attribute} labels
:canonical: arelle.ModelRelationshipSet._LangLabels.labels
:type: list[arelle.ModelObject.ModelObject] | list[str]
:value: >
   None

```{autodoc2-docstring} arelle.ModelRelationshipSet._LangLabels.labels
```

````

`````

`````{py:class} ModelRelationshipSet(modelXbrl: arelle.ModelXbrl.ModelXbrl, arcrole: tuple[str, ...] | str, linkrole: tuple[str, ...] | str | None = None, linkqname: arelle.ModelValue.QName | None = None, arcqname: arelle.ModelValue.QName | None = None, includeProhibits: bool = False)
:canonical: arelle.ModelRelationshipSet.ModelRelationshipSet

```{autodoc2-docstring} arelle.ModelRelationshipSet.ModelRelationshipSet
```

```{rubric} Initialization
```

```{autodoc2-docstring} arelle.ModelRelationshipSet.ModelRelationshipSet.__init__
```

````{py:attribute} __slots__
:canonical: arelle.ModelRelationshipSet.ModelRelationshipSet.__slots__
:value: >
   ('isChanged', 'modelXbrl', 'arcrole', 'linkrole', 'linkqname', 'arcqname', 'modelRelationshipsFrom',...

```{autodoc2-docstring} arelle.ModelRelationshipSet.ModelRelationshipSet.__slots__
```

````

````{py:attribute} modelRelationshipsFrom
:canonical: arelle.ModelRelationshipSet.ModelRelationshipSet.modelRelationshipsFrom
:type: dict[typing.Any, list[arelle.ModelDtsObject.ModelRelationship]] | None
:value: >
   None

```{autodoc2-docstring} arelle.ModelRelationshipSet.ModelRelationshipSet.modelRelationshipsFrom
```

````

````{py:attribute} modelRelationshipsTo
:canonical: arelle.ModelRelationshipSet.ModelRelationshipSet.modelRelationshipsTo
:type: dict[typing.Any, list[arelle.ModelDtsObject.ModelRelationship]] | None
:value: >
   None

```{autodoc2-docstring} arelle.ModelRelationshipSet.ModelRelationshipSet.modelRelationshipsTo
```

````

````{py:method} clear() -> None
:canonical: arelle.ModelRelationshipSet.ModelRelationshipSet.clear

```{autodoc2-docstring} arelle.ModelRelationshipSet.ModelRelationshipSet.clear
```

````

````{py:method} __bool__() -> bool
:canonical: arelle.ModelRelationshipSet.ModelRelationshipSet.__bool__

```{autodoc2-docstring} arelle.ModelRelationshipSet.ModelRelationshipSet.__bool__
```

````

````{py:method} contains(modelObject: arelle.ModelObject.ModelObject) -> bool
:canonical: arelle.ModelRelationshipSet.ModelRelationshipSet.contains

```{autodoc2-docstring} arelle.ModelRelationshipSet.ModelRelationshipSet.contains
```

````

````{py:property} linkRoleUris
:canonical: arelle.ModelRelationshipSet.ModelRelationshipSet.linkRoleUris
:type: arelle.PythonUtil.OrderedSet[str]

```{autodoc2-docstring} arelle.ModelRelationshipSet.ModelRelationshipSet.linkRoleUris
```

````

````{py:method} loadModelRelationshipsFrom() -> dict[arelle.ModelObject.ModelObject, list[arelle.ModelDtsObject.ModelRelationship]]
:canonical: arelle.ModelRelationshipSet.ModelRelationshipSet.loadModelRelationshipsFrom

```{autodoc2-docstring} arelle.ModelRelationshipSet.ModelRelationshipSet.loadModelRelationshipsFrom
```

````

````{py:method} loadModelRelationshipsTo() -> dict[arelle.ModelObject.ModelObject, list[arelle.ModelDtsObject.ModelRelationship]]
:canonical: arelle.ModelRelationshipSet.ModelRelationshipSet.loadModelRelationshipsTo

```{autodoc2-docstring} arelle.ModelRelationshipSet.ModelRelationshipSet.loadModelRelationshipsTo
```

````

````{py:method} fromModelObjects() -> dict[typing.Any, list[arelle.ModelDtsObject.ModelRelationship]]
:canonical: arelle.ModelRelationshipSet.ModelRelationshipSet.fromModelObjects

```{autodoc2-docstring} arelle.ModelRelationshipSet.ModelRelationshipSet.fromModelObjects
```

````

````{py:method} fromModelObject(modelFrom: arelle.ModelObject.ModelObject) -> list[arelle.ModelDtsObject.ModelRelationship]
:canonical: arelle.ModelRelationshipSet.ModelRelationshipSet.fromModelObject

```{autodoc2-docstring} arelle.ModelRelationshipSet.ModelRelationshipSet.fromModelObject
```

````

````{py:method} toModelObjects() -> dict[typing.Any, list[arelle.ModelDtsObject.ModelRelationship]]
:canonical: arelle.ModelRelationshipSet.ModelRelationshipSet.toModelObjects

```{autodoc2-docstring} arelle.ModelRelationshipSet.ModelRelationshipSet.toModelObjects
```

````

````{py:method} toModelObject(modelTo: arelle.ModelObject.ModelObject) -> list[arelle.ModelDtsObject.ModelRelationship]
:canonical: arelle.ModelRelationshipSet.ModelRelationshipSet.toModelObject

```{autodoc2-docstring} arelle.ModelRelationshipSet.ModelRelationshipSet.toModelObject
```

````

````{py:method} fromToModelObjects(modelFrom: arelle.ModelObject.ModelObject, modelTo: arelle.ModelObject.ModelObject, checkBothDirections: bool = False) -> list[arelle.ModelDtsObject.ModelRelationship]
:canonical: arelle.ModelRelationshipSet.ModelRelationshipSet.fromToModelObjects

```{autodoc2-docstring} arelle.ModelRelationshipSet.ModelRelationshipSet.fromToModelObjects
```

````

````{py:property} rootConcepts
:canonical: arelle.ModelRelationshipSet.ModelRelationshipSet.rootConcepts
:type: list[arelle.ModelObject.ModelObject]

```{autodoc2-docstring} arelle.ModelRelationshipSet.ModelRelationshipSet.rootConcepts
```

````

````{py:method} isRelated(modelFrom: arelle.ModelObject.ModelObject, axis: str, modelTo: arelle.ModelObject.ModelObject | None = None, visited: set[arelle.ModelObject.ModelObject] | None = None, isDRS: bool = False, consecutiveLinkrole: bool = False) -> bool
:canonical: arelle.ModelRelationshipSet.ModelRelationshipSet.isRelated

```{autodoc2-docstring} arelle.ModelRelationshipSet.ModelRelationshipSet.isRelated
```

````

````{py:method} label(modelFrom: arelle.ModelObject.ModelObject, role: str, lang: str, returnMultiple: bool = False, returnText: bool = True, linkroleHint: str | None = None) -> str | arelle.ModelObject.ModelObject | list[str] | list[arelle.ModelObject.ModelObject] | None
:canonical: arelle.ModelRelationshipSet.ModelRelationshipSet.label

```{autodoc2-docstring} arelle.ModelRelationshipSet.ModelRelationshipSet.label
```

````

`````

````{py:function} _view_util_attr(name: str) -> typing.Any
:canonical: arelle.ModelRelationshipSet._view_util_attr

```{autodoc2-docstring} arelle.ModelRelationshipSet._view_util_attr
```
````

````{py:data} _DEPRECATIONS
:canonical: arelle.ModelRelationshipSet._DEPRECATIONS
:value: >
   'ModuleDeprecations(...)'

```{autodoc2-docstring} arelle.ModelRelationshipSet._DEPRECATIONS
```

````

````{py:function} __getattr__(name: str) -> typing.Any
:canonical: arelle.ModelRelationshipSet.__getattr__

```{autodoc2-docstring} arelle.ModelRelationshipSet.__getattr__
```
````