Documentation
Documentation
API Reference
API Reference
cauldron.display
bokehcode_blockelapsedheadheaderhtmlimageinspectjinjajsonlatexlistinglist_gridmarkdownplotlypyplotstatussvgtabletailtextwhitespacecauldron.display
bokehcode_blockelapsedheadheaderhtmlimageinspectjinjajsonlatexlistinglist_gridmarkdownplotlypyplotstatussvgtabletailtextwhitespacecauldron.project
stopcauldron.project
stopwrite_to_console
Writes the specified message to the console stdout without including it in the notebook display.
message
str
Background
This function will write strings to the console without them appearing
in the display. This is useful for logging information to the console
that would clutter the display.
Basic Usage
For example, we may want to track memory used by a DataFrame in the
console for reference, but not display that information within the
notebook:
01
02
03
04
05
06
07
08
import cauldron as cd
import pandas as pd
import some_library
data_frame: pd.DataFrame = some_libray.load_data()
bytes_used = data_frame.memory_usage.sum()
cd.step.write_to_console(f'Loaded DataFrame using {bytes_used} bytes.')