Skip to content

Commit

Permalink
Update vame.community() function parameters in running.mdx
Browse files Browse the repository at this point in the history
  • Loading branch information
katiekly authored Sep 30, 2024
1 parent 8332bc7 commit a4a7f61
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/vame-docs-app/docs/getting_started/running.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -168,9 +168,9 @@ vame.motif_videos(config, videoType='.mp4')
#### 3.2 Run community detection
To create behavioral hierarchies and communities detection run:
```python
vame.community(config, show_umap=False, cut_tree=2, cohort=False)
vame.community(config, parametrization='hmm', cut_tree=2, cohort=False)
```
It will produce a tree plot of the behavioural hierarchies
It will produce a tree plot of the behavioural hierarchies using hmm motifs.

#### 3.3 Community Videos
Create community videos to get insights about behavior on a hierarchical scale.
Expand Down Expand Up @@ -207,4 +207,4 @@ vame.gif(config, pose_ref_index=[0,5], subtract_background=True, start=None,
```
:::tip
Once the frames are saved you can create a video or gif via e.g. ImageJ or other tools
:::
:::

0 comments on commit a4a7f61

Please sign in to comment.