repo
stringlengths
7
55
path
stringlengths
4
127
func_name
stringlengths
1
88
original_string
stringlengths
75
19.8k
language
stringclasses
1 value
code
stringlengths
75
19.8k
code_tokens
list
docstring
stringlengths
3
17.3k
docstring_tokens
list
sha
stringlengths
40
40
url
stringlengths
87
242
partition
stringclasses
1 value
moderngl/moderngl
examples/window/base.py
BaseWindow.set_default_viewport
def set_default_viewport(self): """ Calculates the viewport based on the configured aspect ratio. Will add black borders and center the viewport if the window do not match the configured viewport. If aspect ratio is None the viewport will be scaled to the entire w...
python
def set_default_viewport(self): """ Calculates the viewport based on the configured aspect ratio. Will add black borders and center the viewport if the window do not match the configured viewport. If aspect ratio is None the viewport will be scaled to the entire w...
[ "def", "set_default_viewport", "(", "self", ")", ":", "if", "self", ".", "aspect_ratio", ":", "expected_width", "=", "int", "(", "self", ".", "buffer_height", "*", "self", ".", "aspect_ratio", ")", "expected_height", "=", "int", "(", "expected_width", "/", "...
Calculates the viewport based on the configured aspect ratio. Will add black borders and center the viewport if the window do not match the configured viewport. If aspect ratio is None the viewport will be scaled to the entire window size regardless of size.
[ "Calculates", "the", "viewport", "based", "on", "the", "configured", "aspect", "ratio", ".", "Will", "add", "black", "borders", "and", "center", "the", "viewport", "if", "the", "window", "do", "not", "match", "the", "configured", "viewport", ".", "If", "aspe...
a8f5dce8dc72ae84a2f9523887fb5f6b620049b9
https://github.com/moderngl/moderngl/blob/a8f5dce8dc72ae84a2f9523887fb5f6b620049b9/examples/window/base.py#L150-L177
train
moderngl/moderngl
examples/window/base.py
BaseWindow.print_context_info
def print_context_info(self): """ Prints moderngl context info. """ print("Context Version:") print('ModernGL:', moderngl.__version__) print('vendor:', self.ctx.info['GL_VENDOR']) print('renderer:', self.ctx.info['GL_RENDERER']) print('version:', s...
python
def print_context_info(self): """ Prints moderngl context info. """ print("Context Version:") print('ModernGL:', moderngl.__version__) print('vendor:', self.ctx.info['GL_VENDOR']) print('renderer:', self.ctx.info['GL_RENDERER']) print('version:', s...
[ "def", "print_context_info", "(", "self", ")", ":", "print", "(", "\"Context Version:\"", ")", "print", "(", "'ModernGL:'", ",", "moderngl", ".", "__version__", ")", "print", "(", "'vendor:'", ",", "self", ".", "ctx", ".", "info", "[", "'GL_VENDOR'", "]", ...
Prints moderngl context info.
[ "Prints", "moderngl", "context", "info", "." ]
a8f5dce8dc72ae84a2f9523887fb5f6b620049b9
https://github.com/moderngl/moderngl/blob/a8f5dce8dc72ae84a2f9523887fb5f6b620049b9/examples/window/base.py#L187-L198
train
moderngl/moderngl
moderngl/texture.py
Texture.read
def read(self, *, level=0, alignment=1) -> bytes: ''' Read the content of the texture into a buffer. Keyword Args: level (int): The mipmap level. alignment (int): The byte alignment of the pixels. Returns: bytes ''' ...
python
def read(self, *, level=0, alignment=1) -> bytes: ''' Read the content of the texture into a buffer. Keyword Args: level (int): The mipmap level. alignment (int): The byte alignment of the pixels. Returns: bytes ''' ...
[ "def", "read", "(", "self", ",", "*", ",", "level", "=", "0", ",", "alignment", "=", "1", ")", "->", "bytes", ":", "return", "self", ".", "mglo", ".", "read", "(", "level", ",", "alignment", ")" ]
Read the content of the texture into a buffer. Keyword Args: level (int): The mipmap level. alignment (int): The byte alignment of the pixels. Returns: bytes
[ "Read", "the", "content", "of", "the", "texture", "into", "a", "buffer", "." ]
a8f5dce8dc72ae84a2f9523887fb5f6b620049b9
https://github.com/moderngl/moderngl/blob/a8f5dce8dc72ae84a2f9523887fb5f6b620049b9/moderngl/texture.py#L270-L282
train
moderngl/moderngl
examples/window/__init__.py
parse_args
def parse_args(args=None): """Parse arguments from sys.argv""" parser = argparse.ArgumentParser() parser.add_argument( '-w', '--window', default="pyqt5", choices=find_window_classes(), help='Name for the window type to use', ) parser.add_argument( ...
python
def parse_args(args=None): """Parse arguments from sys.argv""" parser = argparse.ArgumentParser() parser.add_argument( '-w', '--window', default="pyqt5", choices=find_window_classes(), help='Name for the window type to use', ) parser.add_argument( ...
[ "def", "parse_args", "(", "args", "=", "None", ")", ":", "parser", "=", "argparse", ".", "ArgumentParser", "(", ")", "parser", ".", "add_argument", "(", "'-w'", ",", "'--window'", ",", "default", "=", "\"pyqt5\"", ",", "choices", "=", "find_window_classes", ...
Parse arguments from sys.argv
[ "Parse", "arguments", "from", "sys", ".", "argv" ]
a8f5dce8dc72ae84a2f9523887fb5f6b620049b9
https://github.com/moderngl/moderngl/blob/a8f5dce8dc72ae84a2f9523887fb5f6b620049b9/examples/window/__init__.py#L65-L99
train
moderngl/moderngl
moderngl/compute_shader.py
ComputeShader.run
def run(self, group_x=1, group_y=1, group_z=1) -> None: ''' Run the compute shader. Args: group_x (int): The number of work groups to be launched in the X dimension. group_y (int): The number of work groups to be launched in the Y dimension. ...
python
def run(self, group_x=1, group_y=1, group_z=1) -> None: ''' Run the compute shader. Args: group_x (int): The number of work groups to be launched in the X dimension. group_y (int): The number of work groups to be launched in the Y dimension. ...
[ "def", "run", "(", "self", ",", "group_x", "=", "1", ",", "group_y", "=", "1", ",", "group_z", "=", "1", ")", "->", "None", ":", "return", "self", ".", "mglo", ".", "run", "(", "group_x", ",", "group_y", ",", "group_z", ")" ]
Run the compute shader. Args: group_x (int): The number of work groups to be launched in the X dimension. group_y (int): The number of work groups to be launched in the Y dimension. group_z (int): The number of work groups to be launched in the Z dimension.
[ "Run", "the", "compute", "shader", "." ]
a8f5dce8dc72ae84a2f9523887fb5f6b620049b9
https://github.com/moderngl/moderngl/blob/a8f5dce8dc72ae84a2f9523887fb5f6b620049b9/moderngl/compute_shader.py#L54-L64
train
moderngl/moderngl
moderngl/compute_shader.py
ComputeShader.get
def get(self, key, default) -> Union[Uniform, UniformBlock, Subroutine, Attribute, Varying]: ''' Returns a Uniform, UniformBlock, Subroutine, Attribute or Varying. Args: default: This is the value to be returned in case key does not exist. Returns: ...
python
def get(self, key, default) -> Union[Uniform, UniformBlock, Subroutine, Attribute, Varying]: ''' Returns a Uniform, UniformBlock, Subroutine, Attribute or Varying. Args: default: This is the value to be returned in case key does not exist. Returns: ...
[ "def", "get", "(", "self", ",", "key", ",", "default", ")", "->", "Union", "[", "Uniform", ",", "UniformBlock", ",", "Subroutine", ",", "Attribute", ",", "Varying", "]", ":", "return", "self", ".", "_members", ".", "get", "(", "key", ",", "default", ...
Returns a Uniform, UniformBlock, Subroutine, Attribute or Varying. Args: default: This is the value to be returned in case key does not exist. Returns: :py:class:`Uniform`, :py:class:`UniformBlock`, :py:class:`Subroutine`, :py:class:`Attribute` o...
[ "Returns", "a", "Uniform", "UniformBlock", "Subroutine", "Attribute", "or", "Varying", "." ]
a8f5dce8dc72ae84a2f9523887fb5f6b620049b9
https://github.com/moderngl/moderngl/blob/a8f5dce8dc72ae84a2f9523887fb5f6b620049b9/moderngl/compute_shader.py#L66-L78
train
moderngl/moderngl
examples/window/sdl2/window.py
Window.resize
def resize(self, width, height): """ Sets the new size and buffer size internally """ self.width = width self.height = height self.buffer_width, self.buffer_height = self.width, self.height self.set_default_viewport() super().resize(self.buffer_w...
python
def resize(self, width, height): """ Sets the new size and buffer size internally """ self.width = width self.height = height self.buffer_width, self.buffer_height = self.width, self.height self.set_default_viewport() super().resize(self.buffer_w...
[ "def", "resize", "(", "self", ",", "width", ",", "height", ")", ":", "self", ".", "width", "=", "width", "self", ".", "height", "=", "height", "self", ".", "buffer_width", ",", "self", ".", "buffer_height", "=", "self", ".", "width", ",", "self", "."...
Sets the new size and buffer size internally
[ "Sets", "the", "new", "size", "and", "buffer", "size", "internally" ]
a8f5dce8dc72ae84a2f9523887fb5f6b620049b9
https://github.com/moderngl/moderngl/blob/a8f5dce8dc72ae84a2f9523887fb5f6b620049b9/examples/window/sdl2/window.py#L76-L85
train
moderngl/moderngl
examples/window/sdl2/window.py
Window.process_events
def process_events(self): """ Loop through and handle all the queued events. """ for event in sdl2.ext.get_events(): if event.type == sdl2.SDL_MOUSEMOTION: self.example.mouse_position_event(event.motion.x, event.motion.y) elif event.type =...
python
def process_events(self): """ Loop through and handle all the queued events. """ for event in sdl2.ext.get_events(): if event.type == sdl2.SDL_MOUSEMOTION: self.example.mouse_position_event(event.motion.x, event.motion.y) elif event.type =...
[ "def", "process_events", "(", "self", ")", ":", "for", "event", "in", "sdl2", ".", "ext", ".", "get_events", "(", ")", ":", "if", "event", ".", "type", "==", "sdl2", ".", "SDL_MOUSEMOTION", ":", "self", ".", "example", ".", "mouse_position_event", "(", ...
Loop through and handle all the queued events.
[ "Loop", "through", "and", "handle", "all", "the", "queued", "events", "." ]
a8f5dce8dc72ae84a2f9523887fb5f6b620049b9
https://github.com/moderngl/moderngl/blob/a8f5dce8dc72ae84a2f9523887fb5f6b620049b9/examples/window/sdl2/window.py#L87-L122
train
moderngl/moderngl
examples/window/sdl2/window.py
Window.destroy
def destroy(self): """ Gracefully close the window """ sdl2.SDL_GL_DeleteContext(self.context) sdl2.SDL_DestroyWindow(self.window) sdl2.SDL_Quit()
python
def destroy(self): """ Gracefully close the window """ sdl2.SDL_GL_DeleteContext(self.context) sdl2.SDL_DestroyWindow(self.window) sdl2.SDL_Quit()
[ "def", "destroy", "(", "self", ")", ":", "sdl2", ".", "SDL_GL_DeleteContext", "(", "self", ".", "context", ")", "sdl2", ".", "SDL_DestroyWindow", "(", "self", ".", "window", ")", "sdl2", ".", "SDL_Quit", "(", ")" ]
Gracefully close the window
[ "Gracefully", "close", "the", "window" ]
a8f5dce8dc72ae84a2f9523887fb5f6b620049b9
https://github.com/moderngl/moderngl/blob/a8f5dce8dc72ae84a2f9523887fb5f6b620049b9/examples/window/sdl2/window.py#L124-L130
train
moderngl/moderngl
examples/window/pyglet/window.py
Window.on_key_press
def on_key_press(self, symbol, modifiers): """ Pyglet specific key press callback. Forwards and translates the events to the example """ self.example.key_event(symbol, self.keys.ACTION_PRESS)
python
def on_key_press(self, symbol, modifiers): """ Pyglet specific key press callback. Forwards and translates the events to the example """ self.example.key_event(symbol, self.keys.ACTION_PRESS)
[ "def", "on_key_press", "(", "self", ",", "symbol", ",", "modifiers", ")", ":", "self", ".", "example", ".", "key_event", "(", "symbol", ",", "self", ".", "keys", ".", "ACTION_PRESS", ")" ]
Pyglet specific key press callback. Forwards and translates the events to the example
[ "Pyglet", "specific", "key", "press", "callback", ".", "Forwards", "and", "translates", "the", "events", "to", "the", "example" ]
a8f5dce8dc72ae84a2f9523887fb5f6b620049b9
https://github.com/moderngl/moderngl/blob/a8f5dce8dc72ae84a2f9523887fb5f6b620049b9/examples/window/pyglet/window.py#L96-L101
train
moderngl/moderngl
examples/window/pyglet/window.py
Window.on_key_release
def on_key_release(self, symbol, modifiers): """ Pyglet specific key release callback. Forwards and translates the events to the example """ self.example.key_event(symbol, self.keys.ACTION_RELEASE)
python
def on_key_release(self, symbol, modifiers): """ Pyglet specific key release callback. Forwards and translates the events to the example """ self.example.key_event(symbol, self.keys.ACTION_RELEASE)
[ "def", "on_key_release", "(", "self", ",", "symbol", ",", "modifiers", ")", ":", "self", ".", "example", ".", "key_event", "(", "symbol", ",", "self", ".", "keys", ".", "ACTION_RELEASE", ")" ]
Pyglet specific key release callback. Forwards and translates the events to the example
[ "Pyglet", "specific", "key", "release", "callback", ".", "Forwards", "and", "translates", "the", "events", "to", "the", "example" ]
a8f5dce8dc72ae84a2f9523887fb5f6b620049b9
https://github.com/moderngl/moderngl/blob/a8f5dce8dc72ae84a2f9523887fb5f6b620049b9/examples/window/pyglet/window.py#L103-L108
train
moderngl/moderngl
examples/window/pyglet/window.py
Window.on_mouse_motion
def on_mouse_motion(self, x, y, dx, dy): """ Pyglet specific mouse motion callback. Forwards and traslates the event to the example """ # Screen coordinates relative to the lower-left corner # so we have to flip the y axis to make this consistent with # oth...
python
def on_mouse_motion(self, x, y, dx, dy): """ Pyglet specific mouse motion callback. Forwards and traslates the event to the example """ # Screen coordinates relative to the lower-left corner # so we have to flip the y axis to make this consistent with # oth...
[ "def", "on_mouse_motion", "(", "self", ",", "x", ",", "y", ",", "dx", ",", "dy", ")", ":", "# Screen coordinates relative to the lower-left corner\r", "# so we have to flip the y axis to make this consistent with\r", "# other window libraries\r", "self", ".", "example", ".", ...
Pyglet specific mouse motion callback. Forwards and traslates the event to the example
[ "Pyglet", "specific", "mouse", "motion", "callback", ".", "Forwards", "and", "traslates", "the", "event", "to", "the", "example" ]
a8f5dce8dc72ae84a2f9523887fb5f6b620049b9
https://github.com/moderngl/moderngl/blob/a8f5dce8dc72ae84a2f9523887fb5f6b620049b9/examples/window/pyglet/window.py#L110-L118
train
moderngl/moderngl
examples/window/pyglet/window.py
Window.on_mouse_press
def on_mouse_press(self, x: int, y: int, button, mods): """ Handle mouse press events and forward to example window """ if button in [1, 4]: self.example.mouse_press_event( x, self.buffer_height - y, 1 if button == 1 else 2, ...
python
def on_mouse_press(self, x: int, y: int, button, mods): """ Handle mouse press events and forward to example window """ if button in [1, 4]: self.example.mouse_press_event( x, self.buffer_height - y, 1 if button == 1 else 2, ...
[ "def", "on_mouse_press", "(", "self", ",", "x", ":", "int", ",", "y", ":", "int", ",", "button", ",", "mods", ")", ":", "if", "button", "in", "[", "1", ",", "4", "]", ":", "self", ".", "example", ".", "mouse_press_event", "(", "x", ",", "self", ...
Handle mouse press events and forward to example window
[ "Handle", "mouse", "press", "events", "and", "forward", "to", "example", "window" ]
a8f5dce8dc72ae84a2f9523887fb5f6b620049b9
https://github.com/moderngl/moderngl/blob/a8f5dce8dc72ae84a2f9523887fb5f6b620049b9/examples/window/pyglet/window.py#L120-L128
train
moderngl/moderngl
examples/window/pyglet/window.py
Window.on_mouse_release
def on_mouse_release(self, x: int, y: int, button, mods): """ Handle mouse release events and forward to example window """ if button in [1, 4]: self.example.mouse_release_event( x, self.buffer_height - y, 1 if button == 1 else 2, ...
python
def on_mouse_release(self, x: int, y: int, button, mods): """ Handle mouse release events and forward to example window """ if button in [1, 4]: self.example.mouse_release_event( x, self.buffer_height - y, 1 if button == 1 else 2, ...
[ "def", "on_mouse_release", "(", "self", ",", "x", ":", "int", ",", "y", ":", "int", ",", "button", ",", "mods", ")", ":", "if", "button", "in", "[", "1", ",", "4", "]", ":", "self", ".", "example", ".", "mouse_release_event", "(", "x", ",", "self...
Handle mouse release events and forward to example window
[ "Handle", "mouse", "release", "events", "and", "forward", "to", "example", "window" ]
a8f5dce8dc72ae84a2f9523887fb5f6b620049b9
https://github.com/moderngl/moderngl/blob/a8f5dce8dc72ae84a2f9523887fb5f6b620049b9/examples/window/pyglet/window.py#L130-L138
train
moderngl/moderngl
moderngl/texture_cube.py
TextureCube.write
def write(self, face, data, viewport=None, *, alignment=1) -> None: ''' Update the content of the texture. Args: face (int): The face to update. data (bytes): The pixel data. viewport (tuple): The viewport. Keyword Args: ...
python
def write(self, face, data, viewport=None, *, alignment=1) -> None: ''' Update the content of the texture. Args: face (int): The face to update. data (bytes): The pixel data. viewport (tuple): The viewport. Keyword Args: ...
[ "def", "write", "(", "self", ",", "face", ",", "data", ",", "viewport", "=", "None", ",", "*", ",", "alignment", "=", "1", ")", "->", "None", ":", "if", "type", "(", "data", ")", "is", "Buffer", ":", "data", "=", "data", ".", "mglo", "self", "....
Update the content of the texture. Args: face (int): The face to update. data (bytes): The pixel data. viewport (tuple): The viewport. Keyword Args: alignment (int): The byte alignment of the pixels.
[ "Update", "the", "content", "of", "the", "texture", "." ]
a8f5dce8dc72ae84a2f9523887fb5f6b620049b9
https://github.com/moderngl/moderngl/blob/a8f5dce8dc72ae84a2f9523887fb5f6b620049b9/moderngl/texture_cube.py#L170-L186
train
moderngl/moderngl
examples/00_empty_window.py
EmptyWindow.key_event
def key_event(self, key, action): """ Handle key events in a generic way supporting all window types. """ if action == self.wnd.keys.ACTION_PRESS: if key == self.wnd.keys.SPACE: print("Space was pressed") if action == self.wnd.keys.ACTION_RELE...
python
def key_event(self, key, action): """ Handle key events in a generic way supporting all window types. """ if action == self.wnd.keys.ACTION_PRESS: if key == self.wnd.keys.SPACE: print("Space was pressed") if action == self.wnd.keys.ACTION_RELE...
[ "def", "key_event", "(", "self", ",", "key", ",", "action", ")", ":", "if", "action", "==", "self", ".", "wnd", ".", "keys", ".", "ACTION_PRESS", ":", "if", "key", "==", "self", ".", "wnd", ".", "keys", ".", "SPACE", ":", "print", "(", "\"Space was...
Handle key events in a generic way supporting all window types.
[ "Handle", "key", "events", "in", "a", "generic", "way", "supporting", "all", "window", "types", "." ]
a8f5dce8dc72ae84a2f9523887fb5f6b620049b9
https://github.com/moderngl/moderngl/blob/a8f5dce8dc72ae84a2f9523887fb5f6b620049b9/examples/00_empty_window.py#L24-L35
train
moderngl/moderngl
examples/00_empty_window.py
EmptyWindow.mouse_press_event
def mouse_press_event(self, x, y, button): """Reports left and right mouse button presses + position""" if button == 1: print("Left mouse button pressed @", x, y) if button == 2: print("Right mouse button pressed @", x, y)
python
def mouse_press_event(self, x, y, button): """Reports left and right mouse button presses + position""" if button == 1: print("Left mouse button pressed @", x, y) if button == 2: print("Right mouse button pressed @", x, y)
[ "def", "mouse_press_event", "(", "self", ",", "x", ",", "y", ",", "button", ")", ":", "if", "button", "==", "1", ":", "print", "(", "\"Left mouse button pressed @\"", ",", "x", ",", "y", ")", "if", "button", "==", "2", ":", "print", "(", "\"Right mouse...
Reports left and right mouse button presses + position
[ "Reports", "left", "and", "right", "mouse", "button", "presses", "+", "position" ]
a8f5dce8dc72ae84a2f9523887fb5f6b620049b9
https://github.com/moderngl/moderngl/blob/a8f5dce8dc72ae84a2f9523887fb5f6b620049b9/examples/00_empty_window.py#L44-L49
train
moderngl/moderngl
examples/00_empty_window.py
EmptyWindow.mouse_release_event
def mouse_release_event(self, x, y, button): """Reports left and right mouse button releases + position""" if button == 1: print("Left mouse button released @", x, y) if button == 2: print("Right mouse button released @", x, y)
python
def mouse_release_event(self, x, y, button): """Reports left and right mouse button releases + position""" if button == 1: print("Left mouse button released @", x, y) if button == 2: print("Right mouse button released @", x, y)
[ "def", "mouse_release_event", "(", "self", ",", "x", ",", "y", ",", "button", ")", ":", "if", "button", "==", "1", ":", "print", "(", "\"Left mouse button released @\"", ",", "x", ",", "y", ")", "if", "button", "==", "2", ":", "print", "(", "\"Right mo...
Reports left and right mouse button releases + position
[ "Reports", "left", "and", "right", "mouse", "button", "releases", "+", "position" ]
a8f5dce8dc72ae84a2f9523887fb5f6b620049b9
https://github.com/moderngl/moderngl/blob/a8f5dce8dc72ae84a2f9523887fb5f6b620049b9/examples/00_empty_window.py#L51-L56
train
moderngl/moderngl
moderngl/program.py
detect_format
def detect_format(program, attributes) -> str: ''' Detect format for vertex attributes. The format returned does not contain padding. Args: program (Program): The program. attributes (list): A list of attribute names. Returns: str ''' de...
python
def detect_format(program, attributes) -> str: ''' Detect format for vertex attributes. The format returned does not contain padding. Args: program (Program): The program. attributes (list): A list of attribute names. Returns: str ''' de...
[ "def", "detect_format", "(", "program", ",", "attributes", ")", "->", "str", ":", "def", "fmt", "(", "attr", ")", ":", "'''\n For internal use only.\n '''", "return", "attr", ".", "array_length", "*", "attr", ".", "dimension", ",", "attr", ".",...
Detect format for vertex attributes. The format returned does not contain padding. Args: program (Program): The program. attributes (list): A list of attribute names. Returns: str
[ "Detect", "format", "for", "vertex", "attributes", ".", "The", "format", "returned", "does", "not", "contain", "padding", "." ]
a8f5dce8dc72ae84a2f9523887fb5f6b620049b9
https://github.com/moderngl/moderngl/blob/a8f5dce8dc72ae84a2f9523887fb5f6b620049b9/moderngl/program.py#L115-L135
train
dswah/pyGAM
pygam/callbacks.py
validate_callback_data
def validate_callback_data(method): """ wraps a callback's method to pull the desired arguments from the vars dict also checks to ensure the method's arguments are in the vars dict Parameters ---------- method : callable Returns ------- validated callable """ @wraps(method)...
python
def validate_callback_data(method): """ wraps a callback's method to pull the desired arguments from the vars dict also checks to ensure the method's arguments are in the vars dict Parameters ---------- method : callable Returns ------- validated callable """ @wraps(method)...
[ "def", "validate_callback_data", "(", "method", ")", ":", "@", "wraps", "(", "method", ")", "def", "method_wrapper", "(", "*", "args", ",", "*", "*", "kwargs", ")", ":", "\"\"\"\n\n Parameters\n ----------\n *args\n **kwargs\n\n Returns\...
wraps a callback's method to pull the desired arguments from the vars dict also checks to ensure the method's arguments are in the vars dict Parameters ---------- method : callable Returns ------- validated callable
[ "wraps", "a", "callback", "s", "method", "to", "pull", "the", "desired", "arguments", "from", "the", "vars", "dict", "also", "checks", "to", "ensure", "the", "method", "s", "arguments", "are", "in", "the", "vars", "dict" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/callbacks.py#L13-L66
train
dswah/pyGAM
pygam/callbacks.py
validate_callback
def validate_callback(callback): """ validates a callback's on_loop_start and on_loop_end methods Parameters ---------- callback : Callback object Returns ------- validated callback """ if not(hasattr(callback, '_validated')) or callback._validated == False: assert hasa...
python
def validate_callback(callback): """ validates a callback's on_loop_start and on_loop_end methods Parameters ---------- callback : Callback object Returns ------- validated callback """ if not(hasattr(callback, '_validated')) or callback._validated == False: assert hasa...
[ "def", "validate_callback", "(", "callback", ")", ":", "if", "not", "(", "hasattr", "(", "callback", ",", "'_validated'", ")", ")", "or", "callback", ".", "_validated", "==", "False", ":", "assert", "hasattr", "(", "callback", ",", "'on_loop_start'", ")", ...
validates a callback's on_loop_start and on_loop_end methods Parameters ---------- callback : Callback object Returns ------- validated callback
[ "validates", "a", "callback", "s", "on_loop_start", "and", "on_loop_end", "methods" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/callbacks.py#L68-L91
train
dswah/pyGAM
pygam/distributions.py
Distribution.phi
def phi(self, y, mu, edof, weights): """ GLM scale parameter. for Binomial and Poisson families this is unity for Normal family this is variance Parameters ---------- y : array-like of length n target values mu : array-like of length n ...
python
def phi(self, y, mu, edof, weights): """ GLM scale parameter. for Binomial and Poisson families this is unity for Normal family this is variance Parameters ---------- y : array-like of length n target values mu : array-like of length n ...
[ "def", "phi", "(", "self", ",", "y", ",", "mu", ",", "edof", ",", "weights", ")", ":", "if", "self", ".", "_known_scale", ":", "return", "self", ".", "scale", "else", ":", "return", "(", "np", ".", "sum", "(", "weights", "*", "self", ".", "V", ...
GLM scale parameter. for Binomial and Poisson families this is unity for Normal family this is variance Parameters ---------- y : array-like of length n target values mu : array-like of length n expected values edof : float est...
[ "GLM", "scale", "parameter", ".", "for", "Binomial", "and", "Poisson", "families", "this", "is", "unity", "for", "Normal", "family", "this", "is", "variance" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/distributions.py#L61-L87
train
dswah/pyGAM
pygam/distributions.py
GammaDist.sample
def sample(self, mu): """ Return random samples from this Gamma distribution. Parameters ---------- mu : array-like of shape n_samples or shape (n_simulations, n_samples) expected values Returns ------- random_samples : np.array of same shape...
python
def sample(self, mu): """ Return random samples from this Gamma distribution. Parameters ---------- mu : array-like of shape n_samples or shape (n_simulations, n_samples) expected values Returns ------- random_samples : np.array of same shape...
[ "def", "sample", "(", "self", ",", "mu", ")", ":", "# in numpy.random.gamma, `shape` is the parameter sometimes denoted by", "# `k` that corresponds to `nu` in S. Wood (2006) Table 2.1", "shape", "=", "1.", "/", "self", ".", "scale", "# in numpy.random.gamma, `scale` is the paramet...
Return random samples from this Gamma distribution. Parameters ---------- mu : array-like of shape n_samples or shape (n_simulations, n_samples) expected values Returns ------- random_samples : np.array of same shape as mu
[ "Return", "random", "samples", "from", "this", "Gamma", "distribution", "." ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/distributions.py#L535-L554
train
dswah/pyGAM
pygam/datasets/load_datasets.py
_clean_X_y
def _clean_X_y(X, y): """ensure that X and y data are float and correct shapes """ return make_2d(X, verbose=False).astype('float'), y.astype('float')
python
def _clean_X_y(X, y): """ensure that X and y data are float and correct shapes """ return make_2d(X, verbose=False).astype('float'), y.astype('float')
[ "def", "_clean_X_y", "(", "X", ",", "y", ")", ":", "return", "make_2d", "(", "X", ",", "verbose", "=", "False", ")", ".", "astype", "(", "'float'", ")", ",", "y", ".", "astype", "(", "'float'", ")" ]
ensure that X and y data are float and correct shapes
[ "ensure", "that", "X", "and", "y", "data", "are", "float", "and", "correct", "shapes" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/datasets/load_datasets.py#L17-L20
train
dswah/pyGAM
pygam/datasets/load_datasets.py
mcycle
def mcycle(return_X_y=True): """motorcyle acceleration dataset Parameters ---------- return_X_y : bool, if True, returns a model-ready tuple of data (X, y) otherwise, returns a Pandas DataFrame Returns ------- model-ready tuple of data (X, y) OR Pandas DataFrame...
python
def mcycle(return_X_y=True): """motorcyle acceleration dataset Parameters ---------- return_X_y : bool, if True, returns a model-ready tuple of data (X, y) otherwise, returns a Pandas DataFrame Returns ------- model-ready tuple of data (X, y) OR Pandas DataFrame...
[ "def", "mcycle", "(", "return_X_y", "=", "True", ")", ":", "# y is real", "# recommend LinearGAM", "motor", "=", "pd", ".", "read_csv", "(", "PATH", "+", "'/mcycle.csv'", ",", "index_col", "=", "0", ")", "if", "return_X_y", ":", "X", "=", "motor", ".", "...
motorcyle acceleration dataset Parameters ---------- return_X_y : bool, if True, returns a model-ready tuple of data (X, y) otherwise, returns a Pandas DataFrame Returns ------- model-ready tuple of data (X, y) OR Pandas DataFrame Notes ----- X contains...
[ "motorcyle", "acceleration", "dataset" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/datasets/load_datasets.py#L22-L52
train
dswah/pyGAM
pygam/datasets/load_datasets.py
coal
def coal(return_X_y=True): """coal-mining accidents dataset Parameters ---------- return_X_y : bool, if True, returns a model-ready tuple of data (X, y) otherwise, returns a Pandas DataFrame Returns ------- model-ready tuple of data (X, y) OR Pandas DataFrame ...
python
def coal(return_X_y=True): """coal-mining accidents dataset Parameters ---------- return_X_y : bool, if True, returns a model-ready tuple of data (X, y) otherwise, returns a Pandas DataFrame Returns ------- model-ready tuple of data (X, y) OR Pandas DataFrame ...
[ "def", "coal", "(", "return_X_y", "=", "True", ")", ":", "# y is counts", "# recommend PoissonGAM", "coal", "=", "pd", ".", "read_csv", "(", "PATH", "+", "'/coal.csv'", ",", "index_col", "=", "0", ")", "if", "return_X_y", ":", "y", ",", "x", "=", "np", ...
coal-mining accidents dataset Parameters ---------- return_X_y : bool, if True, returns a model-ready tuple of data (X, y) otherwise, returns a Pandas DataFrame Returns ------- model-ready tuple of data (X, y) OR Pandas DataFrame Notes ----- The (X, y) ...
[ "coal", "-", "mining", "accidents", "dataset" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/datasets/load_datasets.py#L54-L88
train
dswah/pyGAM
pygam/datasets/load_datasets.py
faithful
def faithful(return_X_y=True): """old-faithful dataset Parameters ---------- return_X_y : bool, if True, returns a model-ready tuple of data (X, y) otherwise, returns a Pandas DataFrame Returns ------- model-ready tuple of data (X, y) OR Pandas DataFrame No...
python
def faithful(return_X_y=True): """old-faithful dataset Parameters ---------- return_X_y : bool, if True, returns a model-ready tuple of data (X, y) otherwise, returns a Pandas DataFrame Returns ------- model-ready tuple of data (X, y) OR Pandas DataFrame No...
[ "def", "faithful", "(", "return_X_y", "=", "True", ")", ":", "# y is counts", "# recommend PoissonGAM", "faithful", "=", "pd", ".", "read_csv", "(", "PATH", "+", "'/faithful.csv'", ",", "index_col", "=", "0", ")", "if", "return_X_y", ":", "y", ",", "x", "=...
old-faithful dataset Parameters ---------- return_X_y : bool, if True, returns a model-ready tuple of data (X, y) otherwise, returns a Pandas DataFrame Returns ------- model-ready tuple of data (X, y) OR Pandas DataFrame Notes ----- The (X, y) tuple is ...
[ "old", "-", "faithful", "dataset" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/datasets/load_datasets.py#L90-L124
train
dswah/pyGAM
pygam/datasets/load_datasets.py
trees
def trees(return_X_y=True): """cherry trees dataset Parameters ---------- return_X_y : bool, if True, returns a model-ready tuple of data (X, y) otherwise, returns a Pandas DataFrame Returns ------- model-ready tuple of data (X, y) OR Pandas DataFrame Notes...
python
def trees(return_X_y=True): """cherry trees dataset Parameters ---------- return_X_y : bool, if True, returns a model-ready tuple of data (X, y) otherwise, returns a Pandas DataFrame Returns ------- model-ready tuple of data (X, y) OR Pandas DataFrame Notes...
[ "def", "trees", "(", "return_X_y", "=", "True", ")", ":", "# y is real.", "# recommend InvGaussGAM, or GAM(distribution='gamma', link='log')", "trees", "=", "pd", ".", "read_csv", "(", "PATH", "+", "'/trees.csv'", ",", "index_col", "=", "0", ")", "if", "return_X_y",...
cherry trees dataset Parameters ---------- return_X_y : bool, if True, returns a model-ready tuple of data (X, y) otherwise, returns a Pandas DataFrame Returns ------- model-ready tuple of data (X, y) OR Pandas DataFrame Notes ----- X contains the girth...
[ "cherry", "trees", "dataset" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/datasets/load_datasets.py#L161-L191
train
dswah/pyGAM
pygam/datasets/load_datasets.py
default
def default(return_X_y=True): """credit default dataset Parameters ---------- return_X_y : bool, if True, returns a model-ready tuple of data (X, y) otherwise, returns a Pandas DataFrame Returns ------- model-ready tuple of data (X, y) OR Pandas DataFrame N...
python
def default(return_X_y=True): """credit default dataset Parameters ---------- return_X_y : bool, if True, returns a model-ready tuple of data (X, y) otherwise, returns a Pandas DataFrame Returns ------- model-ready tuple of data (X, y) OR Pandas DataFrame N...
[ "def", "default", "(", "return_X_y", "=", "True", ")", ":", "# y is binary", "# recommend LogisticGAM", "default", "=", "pd", ".", "read_csv", "(", "PATH", "+", "'/default.csv'", ",", "index_col", "=", "0", ")", "if", "return_X_y", ":", "default", "=", "defa...
credit default dataset Parameters ---------- return_X_y : bool, if True, returns a model-ready tuple of data (X, y) otherwise, returns a Pandas DataFrame Returns ------- model-ready tuple of data (X, y) OR Pandas DataFrame Notes ----- X contains the cat...
[ "credit", "default", "dataset" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/datasets/load_datasets.py#L193-L228
train
dswah/pyGAM
pygam/datasets/load_datasets.py
hepatitis
def hepatitis(return_X_y=True): """hepatitis in Bulgaria dataset Parameters ---------- return_X_y : bool, if True, returns a model-ready tuple of data (X, y) otherwise, returns a Pandas DataFrame Returns ------- model-ready tuple of data (X, y) OR Pandas DataFra...
python
def hepatitis(return_X_y=True): """hepatitis in Bulgaria dataset Parameters ---------- return_X_y : bool, if True, returns a model-ready tuple of data (X, y) otherwise, returns a Pandas DataFrame Returns ------- model-ready tuple of data (X, y) OR Pandas DataFra...
[ "def", "hepatitis", "(", "return_X_y", "=", "True", ")", ":", "# y is real", "# recommend LinearGAM", "hep", "=", "pd", ".", "read_csv", "(", "PATH", "+", "'/hepatitis_A_bulgaria.csv'", ")", ".", "astype", "(", "float", ")", "if", "return_X_y", ":", "# elimina...
hepatitis in Bulgaria dataset Parameters ---------- return_X_y : bool, if True, returns a model-ready tuple of data (X, y) otherwise, returns a Pandas DataFrame Returns ------- model-ready tuple of data (X, y) OR Pandas DataFrame Notes ----- X contains ...
[ "hepatitis", "in", "Bulgaria", "dataset" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/datasets/load_datasets.py#L266-L304
train
dswah/pyGAM
pygam/datasets/load_datasets.py
toy_classification
def toy_classification(return_X_y=True, n=5000): """toy classification dataset with irrelevant features fitting a logistic model on this data and performing a model summary should reveal that features 2,3,4 are not significant. Parameters ---------- return_X_y : bool, if True, returns ...
python
def toy_classification(return_X_y=True, n=5000): """toy classification dataset with irrelevant features fitting a logistic model on this data and performing a model summary should reveal that features 2,3,4 are not significant. Parameters ---------- return_X_y : bool, if True, returns ...
[ "def", "toy_classification", "(", "return_X_y", "=", "True", ",", "n", "=", "5000", ")", ":", "# make features", "X", "=", "np", ".", "random", ".", "rand", "(", "n", ",", "5", ")", "*", "10", "-", "5", "cat", "=", "np", ".", "random", ".", "rand...
toy classification dataset with irrelevant features fitting a logistic model on this data and performing a model summary should reveal that features 2,3,4 are not significant. Parameters ---------- return_X_y : bool, if True, returns a model-ready tuple of data (X, y) otherwise, re...
[ "toy", "classification", "dataset", "with", "irrelevant", "features" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/datasets/load_datasets.py#L306-L361
train
dswah/pyGAM
pygam/datasets/load_datasets.py
head_circumference
def head_circumference(return_X_y=True): """head circumference for dutch boys Parameters ---------- return_X_y : bool, if True, returns a model-ready tuple of data (X, y) otherwise, returns a Pandas DataFrame Returns ------- model-ready tuple of data (X, y) OR P...
python
def head_circumference(return_X_y=True): """head circumference for dutch boys Parameters ---------- return_X_y : bool, if True, returns a model-ready tuple of data (X, y) otherwise, returns a Pandas DataFrame Returns ------- model-ready tuple of data (X, y) OR P...
[ "def", "head_circumference", "(", "return_X_y", "=", "True", ")", ":", "# y is real", "# recommend ExpectileGAM", "head", "=", "pd", ".", "read_csv", "(", "PATH", "+", "'/head_circumference.csv'", ",", "index_col", "=", "0", ")", ".", "astype", "(", "float", "...
head circumference for dutch boys Parameters ---------- return_X_y : bool, if True, returns a model-ready tuple of data (X, y) otherwise, returns a Pandas DataFrame Returns ------- model-ready tuple of data (X, y) OR Pandas DataFrame Notes ----- X conta...
[ "head", "circumference", "for", "dutch", "boys" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/datasets/load_datasets.py#L363-L391
train
dswah/pyGAM
pygam/datasets/load_datasets.py
chicago
def chicago(return_X_y=True): """Chicago air pollution and death rate data Parameters ---------- return_X_y : bool, if True, returns a model-ready tuple of data (X, y) otherwise, returns a Pandas DataFrame Returns ------- model-ready tuple of data (X, y) OR Pand...
python
def chicago(return_X_y=True): """Chicago air pollution and death rate data Parameters ---------- return_X_y : bool, if True, returns a model-ready tuple of data (X, y) otherwise, returns a Pandas DataFrame Returns ------- model-ready tuple of data (X, y) OR Pand...
[ "def", "chicago", "(", "return_X_y", "=", "True", ")", ":", "# recommend PoissonGAM", "chi", "=", "pd", ".", "read_csv", "(", "PATH", "+", "'/chicago.csv'", ",", "index_col", "=", "0", ")", ".", "astype", "(", "float", ")", "if", "return_X_y", ":", "chi"...
Chicago air pollution and death rate data Parameters ---------- return_X_y : bool, if True, returns a model-ready tuple of data (X, y) otherwise, returns a Pandas DataFrame Returns ------- model-ready tuple of data (X, y) OR Pandas DataFrame Notes ----- ...
[ "Chicago", "air", "pollution", "and", "death", "rate", "data" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/datasets/load_datasets.py#L393-L442
train
dswah/pyGAM
pygam/datasets/load_datasets.py
toy_interaction
def toy_interaction(return_X_y=True, n=50000, stddev=0.1): """a sinusoid modulated by a linear function this is a simple dataset to test a model's capacity to fit interactions between features. a GAM with no interaction terms will have an R-squared close to 0, while a GAM with a tensor product wil...
python
def toy_interaction(return_X_y=True, n=50000, stddev=0.1): """a sinusoid modulated by a linear function this is a simple dataset to test a model's capacity to fit interactions between features. a GAM with no interaction terms will have an R-squared close to 0, while a GAM with a tensor product wil...
[ "def", "toy_interaction", "(", "return_X_y", "=", "True", ",", "n", "=", "50000", ",", "stddev", "=", "0.1", ")", ":", "X", "=", "np", ".", "random", ".", "uniform", "(", "-", "1", ",", "1", ",", "size", "=", "(", "n", ",", "2", ")", ")", "X"...
a sinusoid modulated by a linear function this is a simple dataset to test a model's capacity to fit interactions between features. a GAM with no interaction terms will have an R-squared close to 0, while a GAM with a tensor product will have R-squared close to 1. the data is random, and will var...
[ "a", "sinusoid", "modulated", "by", "a", "linear", "function" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/datasets/load_datasets.py#L444-L493
train
dswah/pyGAM
gen_imgs.py
gen_multi_data
def gen_multi_data(n=5000): """ multivariate Logistic problem """ X, y = toy_classification(return_X_y=True, n=10000) lgam = LogisticGAM(s(0) + s(1) + s(2) + s(3) + s(4) + f(5)) lgam.fit(X, y) plt.figure() for i, term in enumerate(lgam.terms): if term.isintercept: c...
python
def gen_multi_data(n=5000): """ multivariate Logistic problem """ X, y = toy_classification(return_X_y=True, n=10000) lgam = LogisticGAM(s(0) + s(1) + s(2) + s(3) + s(4) + f(5)) lgam.fit(X, y) plt.figure() for i, term in enumerate(lgam.terms): if term.isintercept: c...
[ "def", "gen_multi_data", "(", "n", "=", "5000", ")", ":", "X", ",", "y", "=", "toy_classification", "(", "return_X_y", "=", "True", ",", "n", "=", "10000", ")", "lgam", "=", "LogisticGAM", "(", "s", "(", "0", ")", "+", "s", "(", "1", ")", "+", ...
multivariate Logistic problem
[ "multivariate", "Logistic", "problem" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/gen_imgs.py#L229-L248
train
dswah/pyGAM
gen_imgs.py
gen_tensor_data
def gen_tensor_data(): """ toy interaction data """ X, y = toy_interaction(return_X_y=True, n=10000) gam = LinearGAM(te(0, 1,lam=0.1)).fit(X, y) XX = gam.generate_X_grid(term=0, meshgrid=True) Z = gam.partial_dependence(term=0, meshgrid=True) fig = plt.figure(figsize=(9,6)) ax = p...
python
def gen_tensor_data(): """ toy interaction data """ X, y = toy_interaction(return_X_y=True, n=10000) gam = LinearGAM(te(0, 1,lam=0.1)).fit(X, y) XX = gam.generate_X_grid(term=0, meshgrid=True) Z = gam.partial_dependence(term=0, meshgrid=True) fig = plt.figure(figsize=(9,6)) ax = p...
[ "def", "gen_tensor_data", "(", ")", ":", "X", ",", "y", "=", "toy_interaction", "(", "return_X_y", "=", "True", ",", "n", "=", "10000", ")", "gam", "=", "LinearGAM", "(", "te", "(", "0", ",", "1", ",", "lam", "=", "0.1", ")", ")", ".", "fit", "...
toy interaction data
[ "toy", "interaction", "data" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/gen_imgs.py#L250-L267
train
dswah/pyGAM
gen_imgs.py
expectiles
def expectiles(): """ a bunch of expectiles """ X, y = mcycle(return_X_y=True) # lets fit the mean model first by CV gam50 = ExpectileGAM(expectile=0.5).gridsearch(X, y) # and copy the smoothing to the other models lam = gam50.lam # now fit a few more models gam95 = Expectile...
python
def expectiles(): """ a bunch of expectiles """ X, y = mcycle(return_X_y=True) # lets fit the mean model first by CV gam50 = ExpectileGAM(expectile=0.5).gridsearch(X, y) # and copy the smoothing to the other models lam = gam50.lam # now fit a few more models gam95 = Expectile...
[ "def", "expectiles", "(", ")", ":", "X", ",", "y", "=", "mcycle", "(", "return_X_y", "=", "True", ")", "# lets fit the mean model first by CV", "gam50", "=", "ExpectileGAM", "(", "expectile", "=", "0.5", ")", ".", "gridsearch", "(", "X", ",", "y", ")", "...
a bunch of expectiles
[ "a", "bunch", "of", "expectiles" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/gen_imgs.py#L287-L318
train
dswah/pyGAM
pygam/utils.py
cholesky
def cholesky(A, sparse=True, verbose=True): """ Choose the best possible cholesky factorizor. if possible, import the Scikit-Sparse sparse Cholesky method. Permutes the output L to ensure A = L.H . L otherwise defaults to numpy's non-sparse version Parameters ---------- A : array-like...
python
def cholesky(A, sparse=True, verbose=True): """ Choose the best possible cholesky factorizor. if possible, import the Scikit-Sparse sparse Cholesky method. Permutes the output L to ensure A = L.H . L otherwise defaults to numpy's non-sparse version Parameters ---------- A : array-like...
[ "def", "cholesky", "(", "A", ",", "sparse", "=", "True", ",", "verbose", "=", "True", ")", ":", "if", "SKSPIMPORT", ":", "A", "=", "sp", ".", "sparse", ".", "csc_matrix", "(", "A", ")", "try", ":", "F", "=", "spcholesky", "(", "A", ")", "# permut...
Choose the best possible cholesky factorizor. if possible, import the Scikit-Sparse sparse Cholesky method. Permutes the output L to ensure A = L.H . L otherwise defaults to numpy's non-sparse version Parameters ---------- A : array-like array to decompose sparse : boolean, defaul...
[ "Choose", "the", "best", "possible", "cholesky", "factorizor", "." ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/utils.py#L33-L90
train
dswah/pyGAM
pygam/utils.py
make_2d
def make_2d(array, verbose=True): """ tiny tool to expand 1D arrays the way i want Parameters ---------- array : array-like verbose : bool, default: True whether to print warnings Returns ------- np.array of with ndim = 2 """ array = np.asarray(array) if array....
python
def make_2d(array, verbose=True): """ tiny tool to expand 1D arrays the way i want Parameters ---------- array : array-like verbose : bool, default: True whether to print warnings Returns ------- np.array of with ndim = 2 """ array = np.asarray(array) if array....
[ "def", "make_2d", "(", "array", ",", "verbose", "=", "True", ")", ":", "array", "=", "np", ".", "asarray", "(", "array", ")", "if", "array", ".", "ndim", "<", "2", ":", "msg", "=", "'Expected 2D input data array, but found {}D. '", "'Expanding to 2D.'", ".",...
tiny tool to expand 1D arrays the way i want Parameters ---------- array : array-like verbose : bool, default: True whether to print warnings Returns ------- np.array of with ndim = 2
[ "tiny", "tool", "to", "expand", "1D", "arrays", "the", "way", "i", "want" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/utils.py#L93-L115
train
dswah/pyGAM
pygam/utils.py
check_array
def check_array(array, force_2d=False, n_feats=None, ndim=None, min_samples=1, name='Input data', verbose=True): """ tool to perform basic data validation. called by check_X and check_y. ensures that data: - is ndim dimensional - contains float-compatible data-types - has at...
python
def check_array(array, force_2d=False, n_feats=None, ndim=None, min_samples=1, name='Input data', verbose=True): """ tool to perform basic data validation. called by check_X and check_y. ensures that data: - is ndim dimensional - contains float-compatible data-types - has at...
[ "def", "check_array", "(", "array", ",", "force_2d", "=", "False", ",", "n_feats", "=", "None", ",", "ndim", "=", "None", ",", "min_samples", "=", "1", ",", "name", "=", "'Input data'", ",", "verbose", "=", "True", ")", ":", "# make array", "if", "forc...
tool to perform basic data validation. called by check_X and check_y. ensures that data: - is ndim dimensional - contains float-compatible data-types - has at least min_samples - has n_feats - is finite Parameters ---------- array : array-like force_2d : boolean, default: F...
[ "tool", "to", "perform", "basic", "data", "validation", ".", "called", "by", "check_X", "and", "check_y", "." ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/utils.py#L118-L192
train
dswah/pyGAM
pygam/utils.py
check_param
def check_param(param, param_name, dtype, constraint=None, iterable=True, max_depth=2): """ checks the dtype of a parameter, and whether it satisfies a numerical contraint Parameters --------- param : object param_name : str, name of the parameter dtype : str, desired dt...
python
def check_param(param, param_name, dtype, constraint=None, iterable=True, max_depth=2): """ checks the dtype of a parameter, and whether it satisfies a numerical contraint Parameters --------- param : object param_name : str, name of the parameter dtype : str, desired dt...
[ "def", "check_param", "(", "param", ",", "param_name", ",", "dtype", ",", "constraint", "=", "None", ",", "iterable", "=", "True", ",", "max_depth", "=", "2", ")", ":", "msg", "=", "[", "]", "msg", ".", "append", "(", "param_name", "+", "\" must be \""...
checks the dtype of a parameter, and whether it satisfies a numerical contraint Parameters --------- param : object param_name : str, name of the parameter dtype : str, desired dtype of the parameter contraint : str, default: None numerical constraint of the parameter. ...
[ "checks", "the", "dtype", "of", "a", "parameter", "and", "whether", "it", "satisfies", "a", "numerical", "contraint" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/utils.py#L341-L400
train
dswah/pyGAM
pygam/utils.py
get_link_domain
def get_link_domain(link, dist): """ tool to identify the domain of a given monotonic link function Parameters ---------- link : Link object dist : Distribution object Returns ------- domain : list of length 2, representing the interval of the domain. """ domain = np.array(...
python
def get_link_domain(link, dist): """ tool to identify the domain of a given monotonic link function Parameters ---------- link : Link object dist : Distribution object Returns ------- domain : list of length 2, representing the interval of the domain. """ domain = np.array(...
[ "def", "get_link_domain", "(", "link", ",", "dist", ")", ":", "domain", "=", "np", ".", "array", "(", "[", "-", "np", ".", "inf", ",", "-", "1", ",", "0", ",", "1", ",", "np", ".", "inf", "]", ")", "domain", "=", "domain", "[", "~", "np", "...
tool to identify the domain of a given monotonic link function Parameters ---------- link : Link object dist : Distribution object Returns ------- domain : list of length 2, representing the interval of the domain.
[ "tool", "to", "identify", "the", "domain", "of", "a", "given", "monotonic", "link", "function" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/utils.py#L402-L417
train
dswah/pyGAM
pygam/utils.py
load_diagonal
def load_diagonal(cov, load=None): """Return the given square matrix with a small amount added to the diagonal to make it positive semi-definite. """ n, m = cov.shape assert n == m, "matrix must be square, but found shape {}".format((n, m)) if load is None: l...
python
def load_diagonal(cov, load=None): """Return the given square matrix with a small amount added to the diagonal to make it positive semi-definite. """ n, m = cov.shape assert n == m, "matrix must be square, but found shape {}".format((n, m)) if load is None: l...
[ "def", "load_diagonal", "(", "cov", ",", "load", "=", "None", ")", ":", "n", ",", "m", "=", "cov", ".", "shape", "assert", "n", "==", "m", ",", "\"matrix must be square, but found shape {}\"", ".", "format", "(", "(", "n", ",", "m", ")", ")", "if", "...
Return the given square matrix with a small amount added to the diagonal to make it positive semi-definite.
[ "Return", "the", "given", "square", "matrix", "with", "a", "small", "amount", "added", "to", "the", "diagonal", "to", "make", "it", "positive", "semi", "-", "definite", "." ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/utils.py#L420-L429
train
dswah/pyGAM
pygam/utils.py
round_to_n_decimal_places
def round_to_n_decimal_places(array, n=3): """ tool to keep round a float to n decimal places. n=3 by default Parameters ---------- array : np.array n : int. number of decimal places to keep Returns ------- array : rounded np.array """ # check if in scientific notation...
python
def round_to_n_decimal_places(array, n=3): """ tool to keep round a float to n decimal places. n=3 by default Parameters ---------- array : np.array n : int. number of decimal places to keep Returns ------- array : rounded np.array """ # check if in scientific notation...
[ "def", "round_to_n_decimal_places", "(", "array", ",", "n", "=", "3", ")", ":", "# check if in scientific notation", "if", "issubclass", "(", "array", ".", "__class__", ",", "float", ")", "and", "'%.e'", "%", "array", "==", "str", "(", "array", ")", ":", "...
tool to keep round a float to n decimal places. n=3 by default Parameters ---------- array : np.array n : int. number of decimal places to keep Returns ------- array : rounded np.array
[ "tool", "to", "keep", "round", "a", "float", "to", "n", "decimal", "places", "." ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/utils.py#L432-L453
train
dswah/pyGAM
pygam/utils.py
space_row
def space_row(left, right, filler=' ', total_width=-1): """space the data in a row with optional filling Arguments --------- left : str, to be aligned left right : str, to be aligned right filler : str, default ' '. must be of length 1 total_width : int, width of line. if ne...
python
def space_row(left, right, filler=' ', total_width=-1): """space the data in a row with optional filling Arguments --------- left : str, to be aligned left right : str, to be aligned right filler : str, default ' '. must be of length 1 total_width : int, width of line. if ne...
[ "def", "space_row", "(", "left", ",", "right", ",", "filler", "=", "' '", ",", "total_width", "=", "-", "1", ")", ":", "left", "=", "str", "(", "left", ")", "right", "=", "str", "(", "right", ")", "filler", "=", "str", "(", "filler", ")", "[", ...
space the data in a row with optional filling Arguments --------- left : str, to be aligned left right : str, to be aligned right filler : str, default ' '. must be of length 1 total_width : int, width of line. if negative number is specified, then that number of spaces ...
[ "space", "the", "data", "in", "a", "row", "with", "optional", "filling" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/utils.py#L489-L515
train
dswah/pyGAM
pygam/utils.py
gen_edge_knots
def gen_edge_knots(data, dtype, verbose=True): """ generate uniform knots from data including the edges of the data for discrete data, assumes k categories in [0, k-1] interval Parameters ---------- data : array-like with one dimension dtype : str in {'categorical', 'numerical'} verbos...
python
def gen_edge_knots(data, dtype, verbose=True): """ generate uniform knots from data including the edges of the data for discrete data, assumes k categories in [0, k-1] interval Parameters ---------- data : array-like with one dimension dtype : str in {'categorical', 'numerical'} verbos...
[ "def", "gen_edge_knots", "(", "data", ",", "dtype", ",", "verbose", "=", "True", ")", ":", "if", "dtype", "not", "in", "[", "'categorical'", ",", "'numerical'", "]", ":", "raise", "ValueError", "(", "'unsupported dtype: {}'", ".", "format", "(", "dtype", "...
generate uniform knots from data including the edges of the data for discrete data, assumes k categories in [0, k-1] interval Parameters ---------- data : array-like with one dimension dtype : str in {'categorical', 'numerical'} verbose : bool, default: True whether to print warnings ...
[ "generate", "uniform", "knots", "from", "data", "including", "the", "edges", "of", "the", "data" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/utils.py#L539-L566
train
dswah/pyGAM
pygam/utils.py
ylogydu
def ylogydu(y, u): """ tool to give desired output for the limit as y -> 0, which is 0 Parameters ---------- y : array-like of len(n) u : array-like of len(n) Returns ------- np.array len(n) """ mask = (np.atleast_1d(y)!=0.) out = np.zeros_like(u) out[mask] = y[mask...
python
def ylogydu(y, u): """ tool to give desired output for the limit as y -> 0, which is 0 Parameters ---------- y : array-like of len(n) u : array-like of len(n) Returns ------- np.array len(n) """ mask = (np.atleast_1d(y)!=0.) out = np.zeros_like(u) out[mask] = y[mask...
[ "def", "ylogydu", "(", "y", ",", "u", ")", ":", "mask", "=", "(", "np", ".", "atleast_1d", "(", "y", ")", "!=", "0.", ")", "out", "=", "np", ".", "zeros_like", "(", "u", ")", "out", "[", "mask", "]", "=", "y", "[", "mask", "]", "*", "np", ...
tool to give desired output for the limit as y -> 0, which is 0 Parameters ---------- y : array-like of len(n) u : array-like of len(n) Returns ------- np.array len(n)
[ "tool", "to", "give", "desired", "output", "for", "the", "limit", "as", "y", "-", ">", "0", "which", "is", "0" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/utils.py#L710-L726
train
dswah/pyGAM
pygam/utils.py
combine
def combine(*args): """ tool to perform tree search via recursion useful for developing the grid in a grid search Parameters ---------- args : list of lists Returns ------- list of all the combinations of the elements in the input lists """ if hasattr(args, '__iter__') and ...
python
def combine(*args): """ tool to perform tree search via recursion useful for developing the grid in a grid search Parameters ---------- args : list of lists Returns ------- list of all the combinations of the elements in the input lists """ if hasattr(args, '__iter__') and ...
[ "def", "combine", "(", "*", "args", ")", ":", "if", "hasattr", "(", "args", ",", "'__iter__'", ")", "and", "(", "len", "(", "args", ")", ">", "1", ")", ":", "subtree", "=", "combine", "(", "*", "args", "[", ":", "-", "1", "]", ")", "tree", "=...
tool to perform tree search via recursion useful for developing the grid in a grid search Parameters ---------- args : list of lists Returns ------- list of all the combinations of the elements in the input lists
[ "tool", "to", "perform", "tree", "search", "via", "recursion", "useful", "for", "developing", "the", "grid", "in", "a", "grid", "search" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/utils.py#L729-L753
train
dswah/pyGAM
pygam/utils.py
isiterable
def isiterable(obj, reject_string=True): """convenience tool to detect if something is iterable. in python3, strings count as iterables to we have the option to exclude them Parameters: ----------- obj : object to analyse reject_string : bool, whether to ignore strings Returns: -------...
python
def isiterable(obj, reject_string=True): """convenience tool to detect if something is iterable. in python3, strings count as iterables to we have the option to exclude them Parameters: ----------- obj : object to analyse reject_string : bool, whether to ignore strings Returns: -------...
[ "def", "isiterable", "(", "obj", ",", "reject_string", "=", "True", ")", ":", "iterable", "=", "hasattr", "(", "obj", ",", "'__len__'", ")", "if", "reject_string", ":", "iterable", "=", "iterable", "and", "not", "isinstance", "(", "obj", ",", "str", ")",...
convenience tool to detect if something is iterable. in python3, strings count as iterables to we have the option to exclude them Parameters: ----------- obj : object to analyse reject_string : bool, whether to ignore strings Returns: -------- bool, if the object is itereable.
[ "convenience", "tool", "to", "detect", "if", "something", "is", "iterable", ".", "in", "python3", "strings", "count", "as", "iterables", "to", "we", "have", "the", "option", "to", "exclude", "them" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/utils.py#L755-L774
train
dswah/pyGAM
pygam/utils.py
check_iterable_depth
def check_iterable_depth(obj, max_depth=100): """find the maximum depth of nesting of the iterable Parameters ---------- obj : iterable max_depth : int, default: 100 maximum depth beyond which we stop counting Returns ------- int """ def find_iterables(obj): ite...
python
def check_iterable_depth(obj, max_depth=100): """find the maximum depth of nesting of the iterable Parameters ---------- obj : iterable max_depth : int, default: 100 maximum depth beyond which we stop counting Returns ------- int """ def find_iterables(obj): ite...
[ "def", "check_iterable_depth", "(", "obj", ",", "max_depth", "=", "100", ")", ":", "def", "find_iterables", "(", "obj", ")", ":", "iterables", "=", "[", "]", "for", "item", "in", "obj", ":", "if", "isiterable", "(", "item", ")", ":", "iterables", "+=",...
find the maximum depth of nesting of the iterable Parameters ---------- obj : iterable max_depth : int, default: 100 maximum depth beyond which we stop counting Returns ------- int
[ "find", "the", "maximum", "depth", "of", "nesting", "of", "the", "iterable" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/utils.py#L776-L800
train
dswah/pyGAM
pygam/utils.py
flatten
def flatten(iterable): """convenience tool to flatten any nested iterable example: flatten([[[],[4]],[[[5,[6,7, []]]]]]) >>> [4, 5, 6, 7] flatten('hello') >>> 'hello' Parameters ---------- iterable Returns ------- flattened object """ if isite...
python
def flatten(iterable): """convenience tool to flatten any nested iterable example: flatten([[[],[4]],[[[5,[6,7, []]]]]]) >>> [4, 5, 6, 7] flatten('hello') >>> 'hello' Parameters ---------- iterable Returns ------- flattened object """ if isite...
[ "def", "flatten", "(", "iterable", ")", ":", "if", "isiterable", "(", "iterable", ")", ":", "flat", "=", "[", "]", "for", "item", "in", "list", "(", "iterable", ")", ":", "item", "=", "flatten", "(", "item", ")", "if", "not", "isiterable", "(", "it...
convenience tool to flatten any nested iterable example: flatten([[[],[4]],[[[5,[6,7, []]]]]]) >>> [4, 5, 6, 7] flatten('hello') >>> 'hello' Parameters ---------- iterable Returns ------- flattened object
[ "convenience", "tool", "to", "flatten", "any", "nested", "iterable" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/utils.py#L802-L830
train
dswah/pyGAM
pygam/utils.py
tensor_product
def tensor_product(a, b, reshape=True): """ compute the tensor protuct of two matrices a and b if a is (n, m_a), b is (n, m_b), then the result is (n, m_a * m_b) if reshape = True. or (n, m_a, m_b) otherwise Parameters --------- a : array-like of shape (n, m_a) b :...
python
def tensor_product(a, b, reshape=True): """ compute the tensor protuct of two matrices a and b if a is (n, m_a), b is (n, m_b), then the result is (n, m_a * m_b) if reshape = True. or (n, m_a, m_b) otherwise Parameters --------- a : array-like of shape (n, m_a) b :...
[ "def", "tensor_product", "(", "a", ",", "b", ",", "reshape", "=", "True", ")", ":", "assert", "a", ".", "ndim", "==", "2", ",", "'matrix a must be 2-dimensional, but found {} dimensions'", ".", "format", "(", "a", ".", "ndim", ")", "assert", "b", ".", "ndi...
compute the tensor protuct of two matrices a and b if a is (n, m_a), b is (n, m_b), then the result is (n, m_a * m_b) if reshape = True. or (n, m_a, m_b) otherwise Parameters --------- a : array-like of shape (n, m_a) b : array-like of shape (n, m_b) reshape : bool, d...
[ "compute", "the", "tensor", "protuct", "of", "two", "matrices", "a", "and", "b" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/utils.py#L833-L882
train
dswah/pyGAM
pygam/links.py
LogitLink.link
def link(self, mu, dist): """ glm link function this is useful for going from mu to the linear prediction Parameters ---------- mu : array-like of legth n dist : Distribution instance Returns ------- lp : np.array of length n """ ...
python
def link(self, mu, dist): """ glm link function this is useful for going from mu to the linear prediction Parameters ---------- mu : array-like of legth n dist : Distribution instance Returns ------- lp : np.array of length n """ ...
[ "def", "link", "(", "self", ",", "mu", ",", "dist", ")", ":", "return", "np", ".", "log", "(", "mu", ")", "-", "np", ".", "log", "(", "dist", ".", "levels", "-", "mu", ")" ]
glm link function this is useful for going from mu to the linear prediction Parameters ---------- mu : array-like of legth n dist : Distribution instance Returns ------- lp : np.array of length n
[ "glm", "link", "function", "this", "is", "useful", "for", "going", "from", "mu", "to", "the", "linear", "prediction" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/links.py#L103-L117
train
dswah/pyGAM
pygam/links.py
LogitLink.mu
def mu(self, lp, dist): """ glm mean function, ie inverse of link function this is useful for going from the linear prediction to mu Parameters ---------- lp : array-like of legth n dist : Distribution instance Returns ------- mu : np.arr...
python
def mu(self, lp, dist): """ glm mean function, ie inverse of link function this is useful for going from the linear prediction to mu Parameters ---------- lp : array-like of legth n dist : Distribution instance Returns ------- mu : np.arr...
[ "def", "mu", "(", "self", ",", "lp", ",", "dist", ")", ":", "elp", "=", "np", ".", "exp", "(", "lp", ")", "return", "dist", ".", "levels", "*", "elp", "/", "(", "elp", "+", "1", ")" ]
glm mean function, ie inverse of link function this is useful for going from the linear prediction to mu Parameters ---------- lp : array-like of legth n dist : Distribution instance Returns ------- mu : np.array of length n
[ "glm", "mean", "function", "ie", "inverse", "of", "link", "function", "this", "is", "useful", "for", "going", "from", "the", "linear", "prediction", "to", "mu" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/links.py#L119-L134
train
dswah/pyGAM
pygam/links.py
LogitLink.gradient
def gradient(self, mu, dist): """ derivative of the link function wrt mu Parameters ---------- mu : array-like of legth n dist : Distribution instance Returns ------- grad : np.array of length n """ return dist.levels/(mu*(dist.le...
python
def gradient(self, mu, dist): """ derivative of the link function wrt mu Parameters ---------- mu : array-like of legth n dist : Distribution instance Returns ------- grad : np.array of length n """ return dist.levels/(mu*(dist.le...
[ "def", "gradient", "(", "self", ",", "mu", ",", "dist", ")", ":", "return", "dist", ".", "levels", "/", "(", "mu", "*", "(", "dist", ".", "levels", "-", "mu", ")", ")" ]
derivative of the link function wrt mu Parameters ---------- mu : array-like of legth n dist : Distribution instance Returns ------- grad : np.array of length n
[ "derivative", "of", "the", "link", "function", "wrt", "mu" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/links.py#L136-L149
train
dswah/pyGAM
pygam/penalties.py
derivative
def derivative(n, coef, derivative=2, periodic=False): """ Builds a penalty matrix for P-Splines with continuous features. Penalizes the squared differences between basis coefficients. Parameters ---------- n : int number of splines coef : unused for compatibility with cons...
python
def derivative(n, coef, derivative=2, periodic=False): """ Builds a penalty matrix for P-Splines with continuous features. Penalizes the squared differences between basis coefficients. Parameters ---------- n : int number of splines coef : unused for compatibility with cons...
[ "def", "derivative", "(", "n", ",", "coef", ",", "derivative", "=", "2", ",", "periodic", "=", "False", ")", ":", "if", "n", "==", "1", ":", "# no derivative for constant functions", "return", "sp", ".", "sparse", ".", "csc_matrix", "(", "0.", ")", "D", ...
Builds a penalty matrix for P-Splines with continuous features. Penalizes the squared differences between basis coefficients. Parameters ---------- n : int number of splines coef : unused for compatibility with constraints derivative: int, default: 2 which derivative d...
[ "Builds", "a", "penalty", "matrix", "for", "P", "-", "Splines", "with", "continuous", "features", ".", "Penalizes", "the", "squared", "differences", "between", "basis", "coefficients", "." ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/penalties.py#L9-L47
train
dswah/pyGAM
pygam/penalties.py
monotonicity_
def monotonicity_(n, coef, increasing=True): """ Builds a penalty matrix for P-Splines with continuous features. Penalizes violation of monotonicity in the feature function. Parameters ---------- n : int number of splines coef : array-like coefficients of the feature functio...
python
def monotonicity_(n, coef, increasing=True): """ Builds a penalty matrix for P-Splines with continuous features. Penalizes violation of monotonicity in the feature function. Parameters ---------- n : int number of splines coef : array-like coefficients of the feature functio...
[ "def", "monotonicity_", "(", "n", ",", "coef", ",", "increasing", "=", "True", ")", ":", "if", "n", "!=", "len", "(", "coef", ".", "ravel", "(", ")", ")", ":", "raise", "ValueError", "(", "'dimension mismatch: expected n equals len(coef), '", "'but found n = {...
Builds a penalty matrix for P-Splines with continuous features. Penalizes violation of monotonicity in the feature function. Parameters ---------- n : int number of splines coef : array-like coefficients of the feature function increasing : bool, default: True whether to...
[ "Builds", "a", "penalty", "matrix", "for", "P", "-", "Splines", "with", "continuous", "features", ".", "Penalizes", "violation", "of", "monotonicity", "in", "the", "feature", "function", "." ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/penalties.py#L71-L106
train
dswah/pyGAM
pygam/penalties.py
none
def none(n, coef): """ Build a matrix of zeros for features that should go unpenalized Parameters ---------- n : int number of splines coef : unused for compatibility with constraints Returns ------- penalty matrix : sparse csc matrix of shape (n,n) """ retu...
python
def none(n, coef): """ Build a matrix of zeros for features that should go unpenalized Parameters ---------- n : int number of splines coef : unused for compatibility with constraints Returns ------- penalty matrix : sparse csc matrix of shape (n,n) """ retu...
[ "def", "none", "(", "n", ",", "coef", ")", ":", "return", "sp", ".", "sparse", ".", "csc_matrix", "(", "np", ".", "zeros", "(", "(", "n", ",", "n", ")", ")", ")" ]
Build a matrix of zeros for features that should go unpenalized Parameters ---------- n : int number of splines coef : unused for compatibility with constraints Returns ------- penalty matrix : sparse csc matrix of shape (n,n)
[ "Build", "a", "matrix", "of", "zeros", "for", "features", "that", "should", "go", "unpenalized" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/penalties.py#L245-L260
train
dswah/pyGAM
pygam/penalties.py
wrap_penalty
def wrap_penalty(p, fit_linear, linear_penalty=0.): """ tool to account for unity penalty on the linear term of any feature. example: p = wrap_penalty(derivative, fit_linear=True)(n, coef) Parameters ---------- p : callable. penalty-matrix-generating function. fit_linear : ...
python
def wrap_penalty(p, fit_linear, linear_penalty=0.): """ tool to account for unity penalty on the linear term of any feature. example: p = wrap_penalty(derivative, fit_linear=True)(n, coef) Parameters ---------- p : callable. penalty-matrix-generating function. fit_linear : ...
[ "def", "wrap_penalty", "(", "p", ",", "fit_linear", ",", "linear_penalty", "=", "0.", ")", ":", "def", "wrapped_p", "(", "n", ",", "*", "args", ")", ":", "if", "fit_linear", ":", "if", "n", "==", "1", ":", "return", "sp", ".", "sparse", ".", "block...
tool to account for unity penalty on the linear term of any feature. example: p = wrap_penalty(derivative, fit_linear=True)(n, coef) Parameters ---------- p : callable. penalty-matrix-generating function. fit_linear : boolean. whether the current feature has a linear term o...
[ "tool", "to", "account", "for", "unity", "penalty", "on", "the", "linear", "term", "of", "any", "feature", "." ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/penalties.py#L262-L291
train
dswah/pyGAM
pygam/penalties.py
sparse_diff
def sparse_diff(array, n=1, axis=-1): """ A ported sparse version of np.diff. Uses recursion to compute higher order differences Parameters ---------- array : sparse array n : int, default: 1 differencing order axis : int, default: -1 axis along which differences are com...
python
def sparse_diff(array, n=1, axis=-1): """ A ported sparse version of np.diff. Uses recursion to compute higher order differences Parameters ---------- array : sparse array n : int, default: 1 differencing order axis : int, default: -1 axis along which differences are com...
[ "def", "sparse_diff", "(", "array", ",", "n", "=", "1", ",", "axis", "=", "-", "1", ")", ":", "if", "(", "n", "<", "0", ")", "or", "(", "int", "(", "n", ")", "!=", "n", ")", ":", "raise", "ValueError", "(", "'Expected order is non-negative integer,...
A ported sparse version of np.diff. Uses recursion to compute higher order differences Parameters ---------- array : sparse array n : int, default: 1 differencing order axis : int, default: -1 axis along which differences are computed Returns ------- diff_array : sp...
[ "A", "ported", "sparse", "version", "of", "np", ".", "diff", ".", "Uses", "recursion", "to", "compute", "higher", "order", "differences" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/penalties.py#L293-L330
train
dswah/pyGAM
pygam/pygam.py
GAM._linear_predictor
def _linear_predictor(self, X=None, modelmat=None, b=None, term=-1): """linear predictor compute the linear predictor portion of the model ie multiply the model matrix by the spline basis coefficients Parameters --------- at least 1 of (X, modelmat) and ...
python
def _linear_predictor(self, X=None, modelmat=None, b=None, term=-1): """linear predictor compute the linear predictor portion of the model ie multiply the model matrix by the spline basis coefficients Parameters --------- at least 1 of (X, modelmat) and ...
[ "def", "_linear_predictor", "(", "self", ",", "X", "=", "None", ",", "modelmat", "=", "None", ",", "b", "=", "None", ",", "term", "=", "-", "1", ")", ":", "if", "modelmat", "is", "None", ":", "modelmat", "=", "self", ".", "_modelmat", "(", "X", "...
linear predictor compute the linear predictor portion of the model ie multiply the model matrix by the spline basis coefficients Parameters --------- at least 1 of (X, modelmat) and at least 1 of (b, feature) X : array-like of shape (n_samples, m_fea...
[ "linear", "predictor", "compute", "the", "linear", "predictor", "portion", "of", "the", "model", "ie", "multiply", "the", "model", "matrix", "by", "the", "spline", "basis", "coefficients" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/pygam.py#L357-L393
train
dswah/pyGAM
pygam/pygam.py
GAM.predict_mu
def predict_mu(self, X): """ preduct expected value of target given model and input X Parameters --------- X : array-like of shape (n_samples, m_features), containing the input dataset Returns ------- y : np.array of shape (n_samples,) ...
python
def predict_mu(self, X): """ preduct expected value of target given model and input X Parameters --------- X : array-like of shape (n_samples, m_features), containing the input dataset Returns ------- y : np.array of shape (n_samples,) ...
[ "def", "predict_mu", "(", "self", ",", "X", ")", ":", "if", "not", "self", ".", "_is_fitted", ":", "raise", "AttributeError", "(", "'GAM has not been fitted. Call fit first.'", ")", "X", "=", "check_X", "(", "X", ",", "n_feats", "=", "self", ".", "statistics...
preduct expected value of target given model and input X Parameters --------- X : array-like of shape (n_samples, m_features), containing the input dataset Returns ------- y : np.array of shape (n_samples,) containing expected values under the mo...
[ "preduct", "expected", "value", "of", "target", "given", "model", "and", "input", "X" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/pygam.py#L395-L417
train
dswah/pyGAM
pygam/pygam.py
GAM._modelmat
def _modelmat(self, X, term=-1): """ Builds a model matrix, B, out of the spline basis for each feature B = [B_0, B_1, ..., B_p] Parameters --------- X : array-like of shape (n_samples, m_features) containing the input dataset term : int, optional ...
python
def _modelmat(self, X, term=-1): """ Builds a model matrix, B, out of the spline basis for each feature B = [B_0, B_1, ..., B_p] Parameters --------- X : array-like of shape (n_samples, m_features) containing the input dataset term : int, optional ...
[ "def", "_modelmat", "(", "self", ",", "X", ",", "term", "=", "-", "1", ")", ":", "X", "=", "check_X", "(", "X", ",", "n_feats", "=", "self", ".", "statistics_", "[", "'m_features'", "]", ",", "edge_knots", "=", "self", ".", "edge_knots_", ",", "dty...
Builds a model matrix, B, out of the spline basis for each feature B = [B_0, B_1, ..., B_p] Parameters --------- X : array-like of shape (n_samples, m_features) containing the input dataset term : int, optional term index for which to compute the model m...
[ "Builds", "a", "model", "matrix", "B", "out", "of", "the", "spline", "basis", "for", "each", "feature" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/pygam.py#L436-L459
train
dswah/pyGAM
pygam/pygam.py
GAM._cholesky
def _cholesky(self, A, **kwargs): """ method to handle potential problems with the cholesky decomposition. will try to increase L2 regularization of the penalty matrix to do away with non-positive-definite errors Parameters ---------- A : np.array Retur...
python
def _cholesky(self, A, **kwargs): """ method to handle potential problems with the cholesky decomposition. will try to increase L2 regularization of the penalty matrix to do away with non-positive-definite errors Parameters ---------- A : np.array Retur...
[ "def", "_cholesky", "(", "self", ",", "A", ",", "*", "*", "kwargs", ")", ":", "# create appropriate-size diagonal matrix", "if", "sp", ".", "sparse", ".", "issparse", "(", "A", ")", ":", "diag", "=", "sp", ".", "sparse", ".", "eye", "(", "A", ".", "s...
method to handle potential problems with the cholesky decomposition. will try to increase L2 regularization of the penalty matrix to do away with non-positive-definite errors Parameters ---------- A : np.array Returns ------- np.array
[ "method", "to", "handle", "potential", "problems", "with", "the", "cholesky", "decomposition", "." ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/pygam.py#L461-L498
train
dswah/pyGAM
pygam/pygam.py
GAM._pseudo_data
def _pseudo_data(self, y, lp, mu): """ compute the pseudo data for a PIRLS iterations Parameters --------- y : array-like of shape (n,) containing target data lp : array-like of shape (n,) containing linear predictions by the model mu : ar...
python
def _pseudo_data(self, y, lp, mu): """ compute the pseudo data for a PIRLS iterations Parameters --------- y : array-like of shape (n,) containing target data lp : array-like of shape (n,) containing linear predictions by the model mu : ar...
[ "def", "_pseudo_data", "(", "self", ",", "y", ",", "lp", ",", "mu", ")", ":", "return", "lp", "+", "(", "y", "-", "mu", ")", "*", "self", ".", "link", ".", "gradient", "(", "mu", ",", "self", ".", "distribution", ")" ]
compute the pseudo data for a PIRLS iterations Parameters --------- y : array-like of shape (n,) containing target data lp : array-like of shape (n,) containing linear predictions by the model mu : array-like of shape (n_samples,) expected val...
[ "compute", "the", "pseudo", "data", "for", "a", "PIRLS", "iterations" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/pygam.py#L542-L559
train
dswah/pyGAM
pygam/pygam.py
GAM._initial_estimate
def _initial_estimate(self, y, modelmat): """ Makes an inital estimate for the model coefficients. For a LinearGAM we simply initialize to small coefficients. For other GAMs we transform the problem to the linear space and solve an unpenalized version. Parameters ...
python
def _initial_estimate(self, y, modelmat): """ Makes an inital estimate for the model coefficients. For a LinearGAM we simply initialize to small coefficients. For other GAMs we transform the problem to the linear space and solve an unpenalized version. Parameters ...
[ "def", "_initial_estimate", "(", "self", ",", "y", ",", "modelmat", ")", ":", "# do a simple initialization for LinearGAMs", "if", "isinstance", "(", "self", ",", "LinearGAM", ")", ":", "n", ",", "m", "=", "modelmat", ".", "shape", "return", "np", ".", "ones...
Makes an inital estimate for the model coefficients. For a LinearGAM we simply initialize to small coefficients. For other GAMs we transform the problem to the linear space and solve an unpenalized version. Parameters --------- y : array-like of shape (n,) ...
[ "Makes", "an", "inital", "estimate", "for", "the", "model", "coefficients", "." ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/pygam.py#L621-L664
train
dswah/pyGAM
pygam/pygam.py
GAM._on_loop_start
def _on_loop_start(self, variables): """ performs on-loop-start actions like callbacks variables contains local namespace variables. Parameters --------- variables : dict of available variables Returns ------- None """ for callba...
python
def _on_loop_start(self, variables): """ performs on-loop-start actions like callbacks variables contains local namespace variables. Parameters --------- variables : dict of available variables Returns ------- None """ for callba...
[ "def", "_on_loop_start", "(", "self", ",", "variables", ")", ":", "for", "callback", "in", "self", ".", "callbacks", ":", "if", "hasattr", "(", "callback", ",", "'on_loop_start'", ")", ":", "self", ".", "logs_", "[", "str", "(", "callback", ")", "]", "...
performs on-loop-start actions like callbacks variables contains local namespace variables. Parameters --------- variables : dict of available variables Returns ------- None
[ "performs", "on", "-", "loop", "-", "start", "actions", "like", "callbacks" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/pygam.py#L834-L850
train
dswah/pyGAM
pygam/pygam.py
GAM._on_loop_end
def _on_loop_end(self, variables): """ performs on-loop-end actions like callbacks variables contains local namespace variables. Parameters --------- variables : dict of available variables Returns ------- None """ for callback i...
python
def _on_loop_end(self, variables): """ performs on-loop-end actions like callbacks variables contains local namespace variables. Parameters --------- variables : dict of available variables Returns ------- None """ for callback i...
[ "def", "_on_loop_end", "(", "self", ",", "variables", ")", ":", "for", "callback", "in", "self", ".", "callbacks", ":", "if", "hasattr", "(", "callback", ",", "'on_loop_end'", ")", ":", "self", ".", "logs_", "[", "str", "(", "callback", ")", "]", ".", ...
performs on-loop-end actions like callbacks variables contains local namespace variables. Parameters --------- variables : dict of available variables Returns ------- None
[ "performs", "on", "-", "loop", "-", "end", "actions", "like", "callbacks" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/pygam.py#L852-L868
train
dswah/pyGAM
pygam/pygam.py
GAM.deviance_residuals
def deviance_residuals(self, X, y, weights=None, scaled=False): """ method to compute the deviance residuals of the model these are analogous to the residuals of an OLS. Parameters ---------- X : array-like Input data array of shape (n_saples, m_features) ...
python
def deviance_residuals(self, X, y, weights=None, scaled=False): """ method to compute the deviance residuals of the model these are analogous to the residuals of an OLS. Parameters ---------- X : array-like Input data array of shape (n_saples, m_features) ...
[ "def", "deviance_residuals", "(", "self", ",", "X", ",", "y", ",", "weights", "=", "None", ",", "scaled", "=", "False", ")", ":", "if", "not", "self", ".", "_is_fitted", ":", "raise", "AttributeError", "(", "'GAM has not been fitted. Call fit first.'", ")", ...
method to compute the deviance residuals of the model these are analogous to the residuals of an OLS. Parameters ---------- X : array-like Input data array of shape (n_saples, m_features) y : array-like Output data vector of shape (n_samples,) we...
[ "method", "to", "compute", "the", "deviance", "residuals", "of", "the", "model" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/pygam.py#L927-L971
train
dswah/pyGAM
pygam/pygam.py
GAM._estimate_model_statistics
def _estimate_model_statistics(self, y, modelmat, inner=None, BW=None, B=None, weights=None, U1=None): """ method to compute all of the model statistics results are stored in the 'statistics_' attribute of the model, as a dictionary keyed by: ...
python
def _estimate_model_statistics(self, y, modelmat, inner=None, BW=None, B=None, weights=None, U1=None): """ method to compute all of the model statistics results are stored in the 'statistics_' attribute of the model, as a dictionary keyed by: ...
[ "def", "_estimate_model_statistics", "(", "self", ",", "y", ",", "modelmat", ",", "inner", "=", "None", ",", "BW", "=", "None", ",", "B", "=", "None", ",", "weights", "=", "None", ",", "U1", "=", "None", ")", ":", "lp", "=", "self", ".", "_linear_p...
method to compute all of the model statistics results are stored in the 'statistics_' attribute of the model, as a dictionary keyed by: - edof: estimated degrees freedom - scale: distribution scale, if applicable - cov: coefficient covariances - se: standarrd errors ...
[ "method", "to", "compute", "all", "of", "the", "model", "statistics" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/pygam.py#L973-L1025
train
dswah/pyGAM
pygam/pygam.py
GAM._estimate_AIC
def _estimate_AIC(self, y, mu, weights=None): """ estimate the Akaike Information Criterion Parameters ---------- y : array-like of shape (n_samples,) output data vector mu : array-like of shape (n_samples,), expected value of the targets given th...
python
def _estimate_AIC(self, y, mu, weights=None): """ estimate the Akaike Information Criterion Parameters ---------- y : array-like of shape (n_samples,) output data vector mu : array-like of shape (n_samples,), expected value of the targets given th...
[ "def", "_estimate_AIC", "(", "self", ",", "y", ",", "mu", ",", "weights", "=", "None", ")", ":", "estimated_scale", "=", "not", "(", "self", ".", "distribution", ".", "_known_scale", ")", "# if we estimate the scale, that adds 2 dof", "return", "-", "2", "*", ...
estimate the Akaike Information Criterion Parameters ---------- y : array-like of shape (n_samples,) output data vector mu : array-like of shape (n_samples,), expected value of the targets given the model and inputs weights : array-like shape (n_samples,)...
[ "estimate", "the", "Akaike", "Information", "Criterion" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/pygam.py#L1027-L1047
train
dswah/pyGAM
pygam/pygam.py
GAM._estimate_AICc
def _estimate_AICc(self, y, mu, weights=None): """ estimate the corrected Akaike Information Criterion relies on the estimated degrees of freedom, which must be computed before. Parameters ---------- y : array-like of shape (n_samples,) output data v...
python
def _estimate_AICc(self, y, mu, weights=None): """ estimate the corrected Akaike Information Criterion relies on the estimated degrees of freedom, which must be computed before. Parameters ---------- y : array-like of shape (n_samples,) output data v...
[ "def", "_estimate_AICc", "(", "self", ",", "y", ",", "mu", ",", "weights", "=", "None", ")", ":", "edof", "=", "self", ".", "statistics_", "[", "'edof'", "]", "if", "self", ".", "statistics_", "[", "'AIC'", "]", "is", "None", ":", "self", ".", "sta...
estimate the corrected Akaike Information Criterion relies on the estimated degrees of freedom, which must be computed before. Parameters ---------- y : array-like of shape (n_samples,) output data vector mu : array-like of shape (n_samples,) exp...
[ "estimate", "the", "corrected", "Akaike", "Information", "Criterion" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/pygam.py#L1049-L1073
train
dswah/pyGAM
pygam/pygam.py
GAM._estimate_r2
def _estimate_r2(self, X=None, y=None, mu=None, weights=None): """ estimate some pseudo R^2 values currently only computes explained deviance. results are stored Parameters ---------- y : array-like of shape (n_samples,) output data vector mu...
python
def _estimate_r2(self, X=None, y=None, mu=None, weights=None): """ estimate some pseudo R^2 values currently only computes explained deviance. results are stored Parameters ---------- y : array-like of shape (n_samples,) output data vector mu...
[ "def", "_estimate_r2", "(", "self", ",", "X", "=", "None", ",", "y", "=", "None", ",", "mu", "=", "None", ",", "weights", "=", "None", ")", ":", "if", "mu", "is", "None", ":", "mu", "=", "self", ".", "predict_mu", "(", "X", "=", "X", ")", "if...
estimate some pseudo R^2 values currently only computes explained deviance. results are stored Parameters ---------- y : array-like of shape (n_samples,) output data vector mu : array-like of shape (n_samples,) expected value of the targets given...
[ "estimate", "some", "pseudo", "R^2", "values" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/pygam.py#L1075-L1115
train
dswah/pyGAM
pygam/pygam.py
GAM._estimate_GCV_UBRE
def _estimate_GCV_UBRE(self, X=None, y=None, modelmat=None, gamma=1.4, add_scale=True, weights=None): """ Generalized Cross Validation and Un-Biased Risk Estimator. UBRE is used when the scale parameter is known, like Poisson and Binomial families. Pa...
python
def _estimate_GCV_UBRE(self, X=None, y=None, modelmat=None, gamma=1.4, add_scale=True, weights=None): """ Generalized Cross Validation and Un-Biased Risk Estimator. UBRE is used when the scale parameter is known, like Poisson and Binomial families. Pa...
[ "def", "_estimate_GCV_UBRE", "(", "self", ",", "X", "=", "None", ",", "y", "=", "None", ",", "modelmat", "=", "None", ",", "gamma", "=", "1.4", ",", "add_scale", "=", "True", ",", "weights", "=", "None", ")", ":", "if", "gamma", "<", "1", ":", "r...
Generalized Cross Validation and Un-Biased Risk Estimator. UBRE is used when the scale parameter is known, like Poisson and Binomial families. Parameters ---------- y : array-like of shape (n_samples,) output data vector modelmat : array-like, default: None ...
[ "Generalized", "Cross", "Validation", "and", "Un", "-", "Biased", "Risk", "Estimator", "." ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/pygam.py#L1117-L1182
train
dswah/pyGAM
pygam/pygam.py
GAM._estimate_p_values
def _estimate_p_values(self): """estimate the p-values for all features """ if not self._is_fitted: raise AttributeError('GAM has not been fitted. Call fit first.') p_values = [] for term_i in range(len(self.terms)): p_values.append(self._compute_p_value(...
python
def _estimate_p_values(self): """estimate the p-values for all features """ if not self._is_fitted: raise AttributeError('GAM has not been fitted. Call fit first.') p_values = [] for term_i in range(len(self.terms)): p_values.append(self._compute_p_value(...
[ "def", "_estimate_p_values", "(", "self", ")", ":", "if", "not", "self", ".", "_is_fitted", ":", "raise", "AttributeError", "(", "'GAM has not been fitted. Call fit first.'", ")", "p_values", "=", "[", "]", "for", "term_i", "in", "range", "(", "len", "(", "sel...
estimate the p-values for all features
[ "estimate", "the", "p", "-", "values", "for", "all", "features" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/pygam.py#L1184-L1194
train
dswah/pyGAM
pygam/pygam.py
GAM._compute_p_value
def _compute_p_value(self, term_i): """compute the p-value of the desired feature Arguments --------- term_i : int term to select from the data Returns ------- p_value : float Notes ----- Wood 2006, section 4.8.5: ...
python
def _compute_p_value(self, term_i): """compute the p-value of the desired feature Arguments --------- term_i : int term to select from the data Returns ------- p_value : float Notes ----- Wood 2006, section 4.8.5: ...
[ "def", "_compute_p_value", "(", "self", ",", "term_i", ")", ":", "if", "not", "self", ".", "_is_fitted", ":", "raise", "AttributeError", "(", "'GAM has not been fitted. Call fit first.'", ")", "idxs", "=", "self", ".", "terms", ".", "get_coef_indices", "(", "ter...
compute the p-value of the desired feature Arguments --------- term_i : int term to select from the data Returns ------- p_value : float Notes ----- Wood 2006, section 4.8.5: The p-values, calculated in this manner, behav...
[ "compute", "the", "p", "-", "value", "of", "the", "desired", "feature" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/pygam.py#L1196-L1248
train
dswah/pyGAM
pygam/pygam.py
GAM.confidence_intervals
def confidence_intervals(self, X, width=.95, quantiles=None): """estimate confidence intervals for the model. Parameters ---------- X : array-like of shape (n_samples, m_features) Input data matrix width : float on [0,1], optional quantiles : array-like of fl...
python
def confidence_intervals(self, X, width=.95, quantiles=None): """estimate confidence intervals for the model. Parameters ---------- X : array-like of shape (n_samples, m_features) Input data matrix width : float on [0,1], optional quantiles : array-like of fl...
[ "def", "confidence_intervals", "(", "self", ",", "X", ",", "width", "=", ".95", ",", "quantiles", "=", "None", ")", ":", "if", "not", "self", ".", "_is_fitted", ":", "raise", "AttributeError", "(", "'GAM has not been fitted. Call fit first.'", ")", "X", "=", ...
estimate confidence intervals for the model. Parameters ---------- X : array-like of shape (n_samples, m_features) Input data matrix width : float on [0,1], optional quantiles : array-like of floats in (0, 1), optional Instead of specifying the prediciton...
[ "estimate", "confidence", "intervals", "for", "the", "model", "." ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/pygam.py#L1250-L1281
train
dswah/pyGAM
pygam/pygam.py
GAM._get_quantiles
def _get_quantiles(self, X, width, quantiles, modelmat=None, lp=None, prediction=False, xform=True, term=-1): """ estimate prediction intervals for LinearGAM Parameters ---------- X : array input data of shape (n_samples, m_features) wi...
python
def _get_quantiles(self, X, width, quantiles, modelmat=None, lp=None, prediction=False, xform=True, term=-1): """ estimate prediction intervals for LinearGAM Parameters ---------- X : array input data of shape (n_samples, m_features) wi...
[ "def", "_get_quantiles", "(", "self", ",", "X", ",", "width", ",", "quantiles", ",", "modelmat", "=", "None", ",", "lp", "=", "None", ",", "prediction", "=", "False", ",", "xform", "=", "True", ",", "term", "=", "-", "1", ")", ":", "if", "quantiles...
estimate prediction intervals for LinearGAM Parameters ---------- X : array input data of shape (n_samples, m_features) width : float on (0, 1) quantiles : array-like of floats on (0, 1) instead of specifying the prediciton width, one can specify the ...
[ "estimate", "prediction", "intervals", "for", "LinearGAM" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/pygam.py#L1283-L1359
train
dswah/pyGAM
pygam/pygam.py
GAM._flatten_mesh
def _flatten_mesh(self, Xs, term): """flatten the mesh and distribute into a feature matrix""" n = Xs[0].size if self.terms[term].istensor: terms = self.terms[term] else: terms = [self.terms[term]] X = np.zeros((n, self.statistics_['m_features'])) ...
python
def _flatten_mesh(self, Xs, term): """flatten the mesh and distribute into a feature matrix""" n = Xs[0].size if self.terms[term].istensor: terms = self.terms[term] else: terms = [self.terms[term]] X = np.zeros((n, self.statistics_['m_features'])) ...
[ "def", "_flatten_mesh", "(", "self", ",", "Xs", ",", "term", ")", ":", "n", "=", "Xs", "[", "0", "]", ".", "size", "if", "self", ".", "terms", "[", "term", "]", ".", "istensor", ":", "terms", "=", "self", ".", "terms", "[", "term", "]", "else",...
flatten the mesh and distribute into a feature matrix
[ "flatten", "the", "mesh", "and", "distribute", "into", "a", "feature", "matrix" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/pygam.py#L1361-L1373
train
dswah/pyGAM
pygam/pygam.py
GAM.generate_X_grid
def generate_X_grid(self, term, n=100, meshgrid=False): """create a nice grid of X data array is sorted by feature and uniformly spaced, so the marginal and joint distributions are likely wrong if term is >= 0, we generate n samples per feature, which results in n^deg samples, ...
python
def generate_X_grid(self, term, n=100, meshgrid=False): """create a nice grid of X data array is sorted by feature and uniformly spaced, so the marginal and joint distributions are likely wrong if term is >= 0, we generate n samples per feature, which results in n^deg samples, ...
[ "def", "generate_X_grid", "(", "self", ",", "term", ",", "n", "=", "100", ",", "meshgrid", "=", "False", ")", ":", "if", "not", "self", ".", "_is_fitted", ":", "raise", "AttributeError", "(", "'GAM has not been fitted. Call fit first.'", ")", "# cant do Intercep...
create a nice grid of X data array is sorted by feature and uniformly spaced, so the marginal and joint distributions are likely wrong if term is >= 0, we generate n samples per feature, which results in n^deg samples, where deg is the degree of the interaction of the term ...
[ "create", "a", "nice", "grid", "of", "X", "data" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/pygam.py#L1375-L1456
train
dswah/pyGAM
pygam/pygam.py
GAM.partial_dependence
def partial_dependence(self, term, X=None, width=None, quantiles=None, meshgrid=False): """ Computes the term functions for the GAM and possibly their confidence intervals. if both width=None and quantiles=None, then no confidence intervals are compute...
python
def partial_dependence(self, term, X=None, width=None, quantiles=None, meshgrid=False): """ Computes the term functions for the GAM and possibly their confidence intervals. if both width=None and quantiles=None, then no confidence intervals are compute...
[ "def", "partial_dependence", "(", "self", ",", "term", ",", "X", "=", "None", ",", "width", "=", "None", ",", "quantiles", "=", "None", ",", "meshgrid", "=", "False", ")", ":", "if", "not", "self", ".", "_is_fitted", ":", "raise", "AttributeError", "("...
Computes the term functions for the GAM and possibly their confidence intervals. if both width=None and quantiles=None, then no confidence intervals are computed Parameters ---------- term : int, optional Term for which to compute the partial dependence func...
[ "Computes", "the", "term", "functions", "for", "the", "GAM", "and", "possibly", "their", "confidence", "intervals", "." ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/pygam.py#L1458-L1570
train
dswah/pyGAM
pygam/pygam.py
GAM.sample
def sample(self, X, y, quantity='y', sample_at_X=None, weights=None, n_draws=100, n_bootstraps=5, objective='auto'): """Simulate from the posterior of the coefficients and smoothing params. Samples are drawn from the posterior of the coefficients and smoothing parameters given th...
python
def sample(self, X, y, quantity='y', sample_at_X=None, weights=None, n_draws=100, n_bootstraps=5, objective='auto'): """Simulate from the posterior of the coefficients and smoothing params. Samples are drawn from the posterior of the coefficients and smoothing parameters given th...
[ "def", "sample", "(", "self", ",", "X", ",", "y", ",", "quantity", "=", "'y'", ",", "sample_at_X", "=", "None", ",", "weights", "=", "None", ",", "n_draws", "=", "100", ",", "n_bootstraps", "=", "5", ",", "objective", "=", "'auto'", ")", ":", "if",...
Simulate from the posterior of the coefficients and smoothing params. Samples are drawn from the posterior of the coefficients and smoothing parameters given the response in an approximate way. The GAM must already be fitted before calling this method; if the model has not been fitted, ...
[ "Simulate", "from", "the", "posterior", "of", "the", "coefficients", "and", "smoothing", "params", "." ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/pygam.py#L1929-L2044
train
dswah/pyGAM
pygam/pygam.py
GAM._sample_coef
def _sample_coef(self, X, y, weights=None, n_draws=100, n_bootstraps=1, objective='auto'): """Simulate from the posterior of the coefficients. NOTE: A `gridsearch` is done `n_bootstraps` many times, so keep `n_bootstraps` small. Make `n_bootstraps < n_draws` to take advanta...
python
def _sample_coef(self, X, y, weights=None, n_draws=100, n_bootstraps=1, objective='auto'): """Simulate from the posterior of the coefficients. NOTE: A `gridsearch` is done `n_bootstraps` many times, so keep `n_bootstraps` small. Make `n_bootstraps < n_draws` to take advanta...
[ "def", "_sample_coef", "(", "self", ",", "X", ",", "y", ",", "weights", "=", "None", ",", "n_draws", "=", "100", ",", "n_bootstraps", "=", "1", ",", "objective", "=", "'auto'", ")", ":", "if", "not", "self", ".", "_is_fitted", ":", "raise", "Attribut...
Simulate from the posterior of the coefficients. NOTE: A `gridsearch` is done `n_bootstraps` many times, so keep `n_bootstraps` small. Make `n_bootstraps < n_draws` to take advantage of the expensive bootstrap samples of the smoothing parameters. Parameters ----------- ...
[ "Simulate", "from", "the", "posterior", "of", "the", "coefficients", "." ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/pygam.py#L2046-L2110
train
dswah/pyGAM
pygam/pygam.py
GAM._bootstrap_samples_of_smoothing
def _bootstrap_samples_of_smoothing(self, X, y, weights=None, n_bootstraps=1, objective='auto'): """Sample the smoothing parameters using simulated response data. For now, the grid of `lam` values is 11 random points in M-dimensional space, where M = the...
python
def _bootstrap_samples_of_smoothing(self, X, y, weights=None, n_bootstraps=1, objective='auto'): """Sample the smoothing parameters using simulated response data. For now, the grid of `lam` values is 11 random points in M-dimensional space, where M = the...
[ "def", "_bootstrap_samples_of_smoothing", "(", "self", ",", "X", ",", "y", ",", "weights", "=", "None", ",", "n_bootstraps", "=", "1", ",", "objective", "=", "'auto'", ")", ":", "mu", "=", "self", ".", "predict_mu", "(", "X", ")", "# Wood pg. 198 step 1", ...
Sample the smoothing parameters using simulated response data. For now, the grid of `lam` values is 11 random points in M-dimensional space, where M = the number of lam values, ie len(flatten(gam.lam)) all values are in [1e-3, 1e3]
[ "Sample", "the", "smoothing", "parameters", "using", "simulated", "response", "data", "." ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/pygam.py#L2112-L2162
train
dswah/pyGAM
pygam/pygam.py
GAM._simulate_coef_from_bootstraps
def _simulate_coef_from_bootstraps( self, n_draws, coef_bootstraps, cov_bootstraps): """Simulate coefficients using bootstrap samples.""" # Sample indices uniformly from {0, ..., n_bootstraps - 1} # (Wood pg. 199 step 6) random_bootstrap_indices = np.random.choice( ...
python
def _simulate_coef_from_bootstraps( self, n_draws, coef_bootstraps, cov_bootstraps): """Simulate coefficients using bootstrap samples.""" # Sample indices uniformly from {0, ..., n_bootstraps - 1} # (Wood pg. 199 step 6) random_bootstrap_indices = np.random.choice( ...
[ "def", "_simulate_coef_from_bootstraps", "(", "self", ",", "n_draws", ",", "coef_bootstraps", ",", "cov_bootstraps", ")", ":", "# Sample indices uniformly from {0, ..., n_bootstraps - 1}", "# (Wood pg. 199 step 6)", "random_bootstrap_indices", "=", "np", ".", "random", ".", "...
Simulate coefficients using bootstrap samples.
[ "Simulate", "coefficients", "using", "bootstrap", "samples", "." ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/pygam.py#L2164-L2191
train
dswah/pyGAM
pygam/pygam.py
LogisticGAM.accuracy
def accuracy(self, X=None, y=None, mu=None): """ computes the accuracy of the LogisticGAM Parameters ---------- note: X or mu must be defined. defaults to mu X : array-like of shape (n_samples, m_features), optional (default=None) containing input data ...
python
def accuracy(self, X=None, y=None, mu=None): """ computes the accuracy of the LogisticGAM Parameters ---------- note: X or mu must be defined. defaults to mu X : array-like of shape (n_samples, m_features), optional (default=None) containing input data ...
[ "def", "accuracy", "(", "self", ",", "X", "=", "None", ",", "y", "=", "None", ",", "mu", "=", "None", ")", ":", "if", "not", "self", ".", "_is_fitted", ":", "raise", "AttributeError", "(", "'GAM has not been fitted. Call fit first.'", ")", "y", "=", "che...
computes the accuracy of the LogisticGAM Parameters ---------- note: X or mu must be defined. defaults to mu X : array-like of shape (n_samples, m_features), optional (default=None) containing input data y : array-like of shape (n,) containing target dat...
[ "computes", "the", "accuracy", "of", "the", "LogisticGAM" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/pygam.py#L2395-L2426
train
dswah/pyGAM
pygam/pygam.py
PoissonGAM._exposure_to_weights
def _exposure_to_weights(self, y, exposure=None, weights=None): """simple tool to create a common API Parameters ---------- y : array-like, shape (n_samples,) Target values (integers in classification, real numbers in regression) For classification, l...
python
def _exposure_to_weights(self, y, exposure=None, weights=None): """simple tool to create a common API Parameters ---------- y : array-like, shape (n_samples,) Target values (integers in classification, real numbers in regression) For classification, l...
[ "def", "_exposure_to_weights", "(", "self", ",", "y", ",", "exposure", "=", "None", ",", "weights", "=", "None", ")", ":", "y", "=", "y", ".", "ravel", "(", ")", "if", "exposure", "is", "not", "None", ":", "exposure", "=", "np", ".", "array", "(", ...
simple tool to create a common API Parameters ---------- y : array-like, shape (n_samples,) Target values (integers in classification, real numbers in regression) For classification, labels must correspond to classes. exposure : array-like shape (n_sa...
[ "simple", "tool", "to", "create", "a", "common", "API" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/pygam.py#L2604-L2654
train
dswah/pyGAM
pygam/pygam.py
PoissonGAM.predict
def predict(self, X, exposure=None): """ preduct expected value of target given model and input X often this is done via expected value of GAM given input X Parameters --------- X : array-like of shape (n_samples, m_features), default: None containing the inp...
python
def predict(self, X, exposure=None): """ preduct expected value of target given model and input X often this is done via expected value of GAM given input X Parameters --------- X : array-like of shape (n_samples, m_features), default: None containing the inp...
[ "def", "predict", "(", "self", ",", "X", ",", "exposure", "=", "None", ")", ":", "if", "not", "self", ".", "_is_fitted", ":", "raise", "AttributeError", "(", "'GAM has not been fitted. Call fit first.'", ")", "X", "=", "check_X", "(", "X", ",", "n_feats", ...
preduct expected value of target given model and input X often this is done via expected value of GAM given input X Parameters --------- X : array-like of shape (n_samples, m_features), default: None containing the input dataset exposure : array-like shape (n_sample...
[ "preduct", "expected", "value", "of", "target", "given", "model", "and", "input", "X", "often", "this", "is", "done", "via", "expected", "value", "of", "GAM", "given", "input", "X" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/pygam.py#L2686-L2718
train
dswah/pyGAM
pygam/pygam.py
PoissonGAM.gridsearch
def gridsearch(self, X, y, exposure=None, weights=None, return_scores=False, keep_best=True, objective='auto', **param_grids): """ performs a grid search over a space of parameters for a given objective NOTE: gridsearch method is lazy and will not r...
python
def gridsearch(self, X, y, exposure=None, weights=None, return_scores=False, keep_best=True, objective='auto', **param_grids): """ performs a grid search over a space of parameters for a given objective NOTE: gridsearch method is lazy and will not r...
[ "def", "gridsearch", "(", "self", ",", "X", ",", "y", ",", "exposure", "=", "None", ",", "weights", "=", "None", ",", "return_scores", "=", "False", ",", "keep_best", "=", "True", ",", "objective", "=", "'auto'", ",", "*", "*", "param_grids", ")", ":...
performs a grid search over a space of parameters for a given objective NOTE: gridsearch method is lazy and will not remove useless combinations from the search space, eg. >>> n_splines=np.arange(5,10), fit_splines=[True, False] will result in 10 loops, of which 5 are equivale...
[ "performs", "a", "grid", "search", "over", "a", "space", "of", "parameters", "for", "a", "given", "objective" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/pygam.py#L2720-L2794
train
dswah/pyGAM
pygam/pygam.py
ExpectileGAM._get_quantile_ratio
def _get_quantile_ratio(self, X, y): """find the expirical quantile of the model Parameters ---------- X : array-like, shape (n_samples, m_features) Training vectors, where n_samples is the number of samples and m_features is the number of features. y : a...
python
def _get_quantile_ratio(self, X, y): """find the expirical quantile of the model Parameters ---------- X : array-like, shape (n_samples, m_features) Training vectors, where n_samples is the number of samples and m_features is the number of features. y : a...
[ "def", "_get_quantile_ratio", "(", "self", ",", "X", ",", "y", ")", ":", "y_pred", "=", "self", ".", "predict", "(", "X", ")", "return", "(", "y_pred", ">", "y", ")", ".", "mean", "(", ")" ]
find the expirical quantile of the model Parameters ---------- X : array-like, shape (n_samples, m_features) Training vectors, where n_samples is the number of samples and m_features is the number of features. y : array-like, shape (n_samples,) Target...
[ "find", "the", "expirical", "quantile", "of", "the", "model" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/pygam.py#L3150-L3168
train
dswah/pyGAM
pygam/pygam.py
ExpectileGAM.fit_quantile
def fit_quantile(self, X, y, quantile, max_iter=20, tol=0.01, weights=None): """fit ExpectileGAM to a desired quantile via binary search Parameters ---------- X : array-like, shape (n_samples, m_features) Training vectors, where n_samples is the number of samples ...
python
def fit_quantile(self, X, y, quantile, max_iter=20, tol=0.01, weights=None): """fit ExpectileGAM to a desired quantile via binary search Parameters ---------- X : array-like, shape (n_samples, m_features) Training vectors, where n_samples is the number of samples ...
[ "def", "fit_quantile", "(", "self", ",", "X", ",", "y", ",", "quantile", ",", "max_iter", "=", "20", ",", "tol", "=", "0.01", ",", "weights", "=", "None", ")", ":", "def", "_within_tol", "(", "a", ",", "b", ",", "tol", ")", ":", "return", "np", ...
fit ExpectileGAM to a desired quantile via binary search Parameters ---------- X : array-like, shape (n_samples, m_features) Training vectors, where n_samples is the number of samples and m_features is the number of features. y : array-like, shape (n_samples,) ...
[ "fit", "ExpectileGAM", "to", "a", "desired", "quantile", "via", "binary", "search" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/pygam.py#L3170-L3238
train
dswah/pyGAM
pygam/core.py
nice_repr
def nice_repr(name, param_kvs, line_width=30, line_offset=5, decimals=3, args=None, flatten_attrs=True): """ tool to do a nice repr of a class. Parameters ---------- name : str class name param_kvs : dict dict containing class parameters names as keys, and the correspond...
python
def nice_repr(name, param_kvs, line_width=30, line_offset=5, decimals=3, args=None, flatten_attrs=True): """ tool to do a nice repr of a class. Parameters ---------- name : str class name param_kvs : dict dict containing class parameters names as keys, and the correspond...
[ "def", "nice_repr", "(", "name", ",", "param_kvs", ",", "line_width", "=", "30", ",", "line_offset", "=", "5", ",", "decimals", "=", "3", ",", "args", "=", "None", ",", "flatten_attrs", "=", "True", ")", ":", "if", "not", "param_kvs", "and", "not", "...
tool to do a nice repr of a class. Parameters ---------- name : str class name param_kvs : dict dict containing class parameters names as keys, and the corresponding values as values line_width : int desired maximum line width. default: 30 line_offset : i...
[ "tool", "to", "do", "a", "nice", "repr", "of", "a", "class", "." ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/core.py#L11-L85
train
dswah/pyGAM
pygam/core.py
Core.get_params
def get_params(self, deep=False): """ returns a dict of all of the object's user-facing parameters Parameters ---------- deep : boolean, default: False when True, also gets non-user-facing paramters Returns ------- dict """ at...
python
def get_params(self, deep=False): """ returns a dict of all of the object's user-facing parameters Parameters ---------- deep : boolean, default: False when True, also gets non-user-facing paramters Returns ------- dict """ at...
[ "def", "get_params", "(", "self", ",", "deep", "=", "False", ")", ":", "attrs", "=", "self", ".", "__dict__", "for", "attr", "in", "self", ".", "_include", ":", "attrs", "[", "attr", "]", "=", "getattr", "(", "self", ",", "attr", ")", "if", "deep",...
returns a dict of all of the object's user-facing parameters Parameters ---------- deep : boolean, default: False when True, also gets non-user-facing paramters Returns ------- dict
[ "returns", "a", "dict", "of", "all", "of", "the", "object", "s", "user", "-", "facing", "parameters" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/core.py#L132-L154
train
dswah/pyGAM
pygam/core.py
Core.set_params
def set_params(self, deep=False, force=False, **parameters): """ sets an object's paramters Parameters ---------- deep : boolean, default: False when True, also sets non-user-facing paramters force : boolean, default: False when True, also sets pa...
python
def set_params(self, deep=False, force=False, **parameters): """ sets an object's paramters Parameters ---------- deep : boolean, default: False when True, also sets non-user-facing paramters force : boolean, default: False when True, also sets pa...
[ "def", "set_params", "(", "self", ",", "deep", "=", "False", ",", "force", "=", "False", ",", "*", "*", "parameters", ")", ":", "param_names", "=", "self", ".", "get_params", "(", "deep", "=", "deep", ")", ".", "keys", "(", ")", "for", "parameter", ...
sets an object's paramters Parameters ---------- deep : boolean, default: False when True, also sets non-user-facing paramters force : boolean, default: False when True, also sets parameters that the object does not already have **parameters :...
[ "sets", "an", "object", "s", "paramters" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/core.py#L156-L179
train
dswah/pyGAM
pygam/terms.py
Term.build_from_info
def build_from_info(cls, info): """build a Term instance from a dict Parameters ---------- cls : class info : dict contains all information needed to build the term Return ------ Term instance """ info = deepcopy(info) ...
python
def build_from_info(cls, info): """build a Term instance from a dict Parameters ---------- cls : class info : dict contains all information needed to build the term Return ------ Term instance """ info = deepcopy(info) ...
[ "def", "build_from_info", "(", "cls", ",", "info", ")", ":", "info", "=", "deepcopy", "(", "info", ")", "if", "'term_type'", "in", "info", ":", "cls_", "=", "TERMS", "[", "info", ".", "pop", "(", "'term_type'", ")", "]", "if", "issubclass", "(", "cls...
build a Term instance from a dict Parameters ---------- cls : class info : dict contains all information needed to build the term Return ------ Term instance
[ "build", "a", "Term", "instance", "from", "a", "dict" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/terms.py#L216-L238
train
dswah/pyGAM
pygam/terms.py
MetaTermMixin._has_terms
def _has_terms(self): """bool, whether the instance has any sub-terms """ loc = self._super_get('_term_location') return self._super_has(loc) \ and isiterable(self._super_get(loc)) \ and len(self._super_get(loc)) > 0 \ and all([isinstance(term...
python
def _has_terms(self): """bool, whether the instance has any sub-terms """ loc = self._super_get('_term_location') return self._super_has(loc) \ and isiterable(self._super_get(loc)) \ and len(self._super_get(loc)) > 0 \ and all([isinstance(term...
[ "def", "_has_terms", "(", "self", ")", ":", "loc", "=", "self", ".", "_super_get", "(", "'_term_location'", ")", "return", "self", ".", "_super_has", "(", "loc", ")", "and", "isiterable", "(", "self", ".", "_super_get", "(", "loc", ")", ")", "and", "le...
bool, whether the instance has any sub-terms
[ "bool", "whether", "the", "instance", "has", "any", "sub", "-", "terms" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/terms.py#L957-L964
train
dswah/pyGAM
pygam/terms.py
TensorTerm.build_from_info
def build_from_info(cls, info): """build a TensorTerm instance from a dict Parameters ---------- cls : class info : dict contains all information needed to build the term Return ------ TensorTerm instance """ terms = [] ...
python
def build_from_info(cls, info): """build a TensorTerm instance from a dict Parameters ---------- cls : class info : dict contains all information needed to build the term Return ------ TensorTerm instance """ terms = [] ...
[ "def", "build_from_info", "(", "cls", ",", "info", ")", ":", "terms", "=", "[", "]", "for", "term_info", "in", "info", "[", "'terms'", "]", ":", "terms", ".", "append", "(", "SplineTerm", ".", "build_from_info", "(", "term_info", ")", ")", "return", "c...
build a TensorTerm instance from a dict Parameters ---------- cls : class info : dict contains all information needed to build the term Return ------ TensorTerm instance
[ "build", "a", "TensorTerm", "instance", "from", "a", "dict" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/terms.py#L1217-L1234
train
dswah/pyGAM
pygam/terms.py
TensorTerm.hasconstraint
def hasconstraint(self): """bool, whether the term has any constraints """ constrained = False for term in self._terms: constrained = constrained or term.hasconstraint return constrained
python
def hasconstraint(self): """bool, whether the term has any constraints """ constrained = False for term in self._terms: constrained = constrained or term.hasconstraint return constrained
[ "def", "hasconstraint", "(", "self", ")", ":", "constrained", "=", "False", "for", "term", "in", "self", ".", "_terms", ":", "constrained", "=", "constrained", "or", "term", ".", "hasconstraint", "return", "constrained" ]
bool, whether the term has any constraints
[ "bool", "whether", "the", "term", "has", "any", "constraints" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/terms.py#L1237-L1243
train
dswah/pyGAM
pygam/terms.py
TensorTerm._build_marginal_constraints
def _build_marginal_constraints(self, i, coef, constraint_lam, constraint_l2): """builds a constraint matrix for a marginal term in the tensor term takes a tensor's coef vector, and slices it into pieces corresponding to term i, then builds a constraint matrix for each piece of the coef vector,...
python
def _build_marginal_constraints(self, i, coef, constraint_lam, constraint_l2): """builds a constraint matrix for a marginal term in the tensor term takes a tensor's coef vector, and slices it into pieces corresponding to term i, then builds a constraint matrix for each piece of the coef vector,...
[ "def", "_build_marginal_constraints", "(", "self", ",", "i", ",", "coef", ",", "constraint_lam", ",", "constraint_l2", ")", ":", "composite_C", "=", "np", ".", "zeros", "(", "(", "len", "(", "coef", ")", ",", "len", "(", "coef", ")", ")", ")", "for", ...
builds a constraint matrix for a marginal term in the tensor term takes a tensor's coef vector, and slices it into pieces corresponding to term i, then builds a constraint matrix for each piece of the coef vector, and assembles them into a composite constraint matrix Parameters ...
[ "builds", "a", "constraint", "matrix", "for", "a", "marginal", "term", "in", "the", "tensor", "term" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/terms.py#L1370-L1412
train
dswah/pyGAM
pygam/terms.py
TensorTerm._iterate_marginal_coef_slices
def _iterate_marginal_coef_slices(self, i): """iterator of indices into tensor's coef vector for marginal term i's coefs takes a tensor_term and returns an iterator of indices that chop up the tensor's coef vector into slices belonging to term i Parameters ---------- i ...
python
def _iterate_marginal_coef_slices(self, i): """iterator of indices into tensor's coef vector for marginal term i's coefs takes a tensor_term and returns an iterator of indices that chop up the tensor's coef vector into slices belonging to term i Parameters ---------- i ...
[ "def", "_iterate_marginal_coef_slices", "(", "self", ",", "i", ")", ":", "dims", "=", "[", "term_", ".", "n_coefs", "for", "term_", "in", "self", "]", "# make all linear indices", "idxs", "=", "np", ".", "arange", "(", "np", ".", "prod", "(", "dims", ")"...
iterator of indices into tensor's coef vector for marginal term i's coefs takes a tensor_term and returns an iterator of indices that chop up the tensor's coef vector into slices belonging to term i Parameters ---------- i : int, index of marginal term Yiel...
[ "iterator", "of", "indices", "into", "tensor", "s", "coef", "vector", "for", "marginal", "term", "i", "s", "coefs" ]
b3e5c3cd580f0a3ad69f9372861624f67760c325
https://github.com/dswah/pyGAM/blob/b3e5c3cd580f0a3ad69f9372861624f67760c325/pygam/terms.py#L1414-L1442
train