semantic_suggestions

semantic_suggestions(x)

Semantic suggestions attached to a dictionary or written package.

:func:suggest_semantics and :func:infer_dictionary attach their candidate shortlist to the returned dictionary as the semantic_suggestions entry of df.attrs, and :func:create_sdp writes the same table to semantic_suggestions.csv inside the package. This is the supported way to read either, so review tooling never has to reach into attrs itself.

Parameters

Name Type Description Default
x A dictionary carrying the attribute, a mapping in the shape returned by :func:infer_salmon_datapackage_artifacts / :func:create_sdp-style inference, or a path to a written Salmon Data Package. required

Returns

Name Type Description
pandas.DataFrame or None Candidate rows, or None when none are attached. The None is deliberate – these accessors replace a raw attrs lookup and must answer an is None test the same way it did.
Back to top