Skip to content

Commit

Permalink
put in a warning about refresh
Browse files Browse the repository at this point in the history
  • Loading branch information
brifordwylie committed Mar 30, 2024
1 parent fe33c8c commit e8c79fe
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/api_classes/meta.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@

::: sageworks.api.meta

## Important
Many of the methods below have a `refresh` argument that's defaulted to False. In almost every situation and use case this is the correct default. Setting `refresh` to `True` will lead to fairly substantial performance issues, so don't do it :).


## Examples
These example show how to use the `Meta()` class to pull lists of artifacts from AWS. DataSources, FeatureSets, Models, Endpoints and more. If you're building a web interface plugin, the **Meta** class is a great place to start.
Expand Down Expand Up @@ -131,4 +134,4 @@ dict_keys(['EndpointName', 'EndpointArn', 'EndpointConfigName', 'ProductionVaria


!!! note "Not Finding some particular AWS Data?"
The SageWorks Meta API Class also has `_details()` methods, so make sure to check those out.
The SageWorks Meta API Class also has `_details()` methods, so make sure to check those out.

0 comments on commit e8c79fe

Please sign in to comment.