Skip to content

Commit ed17d7a

Browse files
committed
merge in main + bump dev's version up for next time
2 parents 1dad080 + 627955a commit ed17d7a

File tree

2 files changed

+8
-10
lines changed

2 files changed

+8
-10
lines changed

README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -56,11 +56,10 @@ from team_comm_tools import FeatureBuilder
5656
Once you import the tool, you will be able to declare a FeatureBuilder object, which is the heart of our tool. Here is some sample syntax:
5757

5858
```python
59-
# this section of code declares a FeatureBuilder object
6059
my_feature_builder = FeatureBuilder(
6160
input_df = my_pandas_dataframe,
6261
# this means there's a column in your data called 'conversation_id' that uniquely identifies a conversation
63-
conversation_id_col = "conversation_id",
62+
conversation_id_col = "conversation_id",
6463
# this means there's a column in your data called 'speaker_id' that uniquely identifies a speaker
6564
speaker_id_col = "speaker_id",
6665
# this means there's a column in your data called 'messagae' that contains the content you want to featurize
@@ -69,14 +68,13 @@ my_feature_builder = FeatureBuilder(
6968
timestamp_col= "timestamp",
7069
# this is where we'll cache things like sentence vectors; this directory doesn't have to exist; we'll create it for you!
7170
vector_directory = "./vector_data/",
72-
# give us names for the utterance (chat), speaker (user), and conversation-level outputs
73-
output_file_path_chat_level = "./my_output_chat_level.csv",
74-
output_file_path_user_level = "./my_output_user_level.csv",
75-
output_file_path_conv_level = "./my_output_conversation_level.csv",
76-
# if true, this will combine successive turns by the same speaker.
71+
# this will be the base file path for which we generate the three outputs;
72+
# you will get your outputs in output/chat/my_output_chat_level.csv; output/conv/my_output_conv_level.csv; and output/user/my_output_user_level.
73+
output_file_base = "my_output"
74+
# it will also store the output into output/turns/my_output_chat_level.csv
7775
turns = False,
7876
# these features depend on sentence vectors, so they take longer to generate on larger datasets. Add them in manually if you are interested in adding them to your output!
79-
custom_features = [
77+
custom_features = [
8078
"(BERT) Mimicry",
8179
"Moving Mimicry",
8280
"Forward Flow",
@@ -104,7 +102,7 @@ Notably, not all communication features are made equal, as they can be defined a
104102
2. The **speaker**, and
105103
3. The **conversation**
106104

107-
**We generate a separate output file for each level.** When you declare a FeatureBuilder, you will need to specify an output path for each level of analysis.
105+
**We generate a separate output file for each level.** When you declare a FeatureBuilder, you can use the `output_file_base` to define a base path shared among all three levels, and an output path will be automatically generated for each level of analysis.
108106

109107
For more information, please refer to the [Introduction on our Read the Docs Page](https://conversational-featurizer.readthedocs.io/en/latest/intro.html#intro).
110108

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
66

77
[project]
88
name = "team_comm_tools"
9-
version = "0.1.4"
9+
version = "0.1.5"
1010
requires-python = ">= 3.10"
1111
dependencies = [
1212
"chardet>=3.0.4",

0 commit comments

Comments
 (0)