taylorai / galactic

data cleaning and curation for unstructured text
Apache License 2.0
322 stars 14 forks source link

params name is inconsistent with actual package and readme #19

Open theblackcat102 opened 4 months ago

theblackcat102 commented 4 months ago

In readme.md, the get_embeddings param name is not the same with actual code:

readme:

dataset.get_embeddings(field="content", backend="cpu")

actual:

dataset.get_embeddings(input_field="content", backend="cpu")

get_cluster_info:

readme:

dataset.get_cluster_info(field="content")

actual:

dataset.get_cluster_info(cluster_field="content")