repo
stringclasses
85 values
path
stringlengths
8
121
func_name
stringlengths
1
82
original_string
stringlengths
112
65.5k
language
stringclasses
1 value
code
stringlengths
112
65.5k
code_tokens
listlengths
20
4.09k
docstring
stringlengths
3
46.3k
docstring_tokens
listlengths
1
564
sha
stringclasses
85 values
url
stringlengths
93
218
partition
stringclasses
1 value
tensorflow/lucid
lucid/optvis/objectives.py
class_logit
def class_logit(layer, label): """Like channel, but for softmax layers. Args: layer: A layer name string. label: Either a string (refering to a label in model.labels) or an int label position. Returns: Objective maximizing a logit. """ def inner(T): if isinstance(label, int): cla...
python
def class_logit(layer, label): """Like channel, but for softmax layers. Args: layer: A layer name string. label: Either a string (refering to a label in model.labels) or an int label position. Returns: Objective maximizing a logit. """ def inner(T): if isinstance(label, int): cla...
[ "def", "class_logit", "(", "layer", ",", "label", ")", ":", "def", "inner", "(", "T", ")", ":", "if", "isinstance", "(", "label", ",", "int", ")", ":", "class_n", "=", "label", "else", ":", "class_n", "=", "T", "(", "\"labels\"", ")", ".", "index",...
Like channel, but for softmax layers. Args: layer: A layer name string. label: Either a string (refering to a label in model.labels) or an int label position. Returns: Objective maximizing a logit.
[ "Like", "channel", "but", "for", "softmax", "layers", "." ]
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/optvis/objectives.py#L442-L461
train
tensorflow/lucid
lucid/optvis/objectives.py
as_objective
def as_objective(obj): """Convert obj into Objective class. Strings of the form "layer:n" become the Objective channel(layer, n). Objectives are returned unchanged. Args: obj: string or Objective. Returns: Objective """ if isinstance(obj, Objective): return obj elif callable(obj): ret...
python
def as_objective(obj): """Convert obj into Objective class. Strings of the form "layer:n" become the Objective channel(layer, n). Objectives are returned unchanged. Args: obj: string or Objective. Returns: Objective """ if isinstance(obj, Objective): return obj elif callable(obj): ret...
[ "def", "as_objective", "(", "obj", ")", ":", "if", "isinstance", "(", "obj", ",", "Objective", ")", ":", "return", "obj", "elif", "callable", "(", "obj", ")", ":", "return", "obj", "elif", "isinstance", "(", "obj", ",", "str", ")", ":", "layer", ",",...
Convert obj into Objective class. Strings of the form "layer:n" become the Objective channel(layer, n). Objectives are returned unchanged. Args: obj: string or Objective. Returns: Objective
[ "Convert", "obj", "into", "Objective", "class", "." ]
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/optvis/objectives.py#L464-L483
train
tensorflow/lucid
lucid/optvis/param/unit_balls.py
_constrain_L2_grad
def _constrain_L2_grad(op, grad): """Gradient for constrained optimization on an L2 unit ball. This function projects the gradient onto the ball if you are on the boundary (or outside!), but leaves it untouched if you are inside the ball. Args: op: the tensorflow op we're computing the gradient for. g...
python
def _constrain_L2_grad(op, grad): """Gradient for constrained optimization on an L2 unit ball. This function projects the gradient onto the ball if you are on the boundary (or outside!), but leaves it untouched if you are inside the ball. Args: op: the tensorflow op we're computing the gradient for. g...
[ "def", "_constrain_L2_grad", "(", "op", ",", "grad", ")", ":", "inp", "=", "op", ".", "inputs", "[", "0", "]", "inp_norm", "=", "tf", ".", "norm", "(", "inp", ")", "unit_inp", "=", "inp", "/", "inp_norm", "grad_projection", "=", "dot", "(", "unit_inp...
Gradient for constrained optimization on an L2 unit ball. This function projects the gradient onto the ball if you are on the boundary (or outside!), but leaves it untouched if you are inside the ball. Args: op: the tensorflow op we're computing the gradient for. grad: gradient we need to backprop Re...
[ "Gradient", "for", "constrained", "optimization", "on", "an", "L2", "unit", "ball", "." ]
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/optvis/param/unit_balls.py#L20-L47
train
tensorflow/lucid
lucid/optvis/param/unit_balls.py
unit_ball_L2
def unit_ball_L2(shape): """A tensorflow variable tranfomed to be constrained in a L2 unit ball. EXPERIMENTAL: Do not use for adverserial examples if you need to be confident they are strong attacks. We are not yet confident in this code. """ x = tf.Variable(tf.zeros(shape)) return constrain_L2(x)
python
def unit_ball_L2(shape): """A tensorflow variable tranfomed to be constrained in a L2 unit ball. EXPERIMENTAL: Do not use for adverserial examples if you need to be confident they are strong attacks. We are not yet confident in this code. """ x = tf.Variable(tf.zeros(shape)) return constrain_L2(x)
[ "def", "unit_ball_L2", "(", "shape", ")", ":", "x", "=", "tf", ".", "Variable", "(", "tf", ".", "zeros", "(", "shape", ")", ")", "return", "constrain_L2", "(", "x", ")" ]
A tensorflow variable tranfomed to be constrained in a L2 unit ball. EXPERIMENTAL: Do not use for adverserial examples if you need to be confident they are strong attacks. We are not yet confident in this code.
[ "A", "tensorflow", "variable", "tranfomed", "to", "be", "constrained", "in", "a", "L2", "unit", "ball", "." ]
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/optvis/param/unit_balls.py#L55-L62
train
tensorflow/lucid
lucid/optvis/param/unit_balls.py
unit_ball_L_inf
def unit_ball_L_inf(shape, precondition=True): """A tensorflow variable tranfomed to be constrained in a L_inf unit ball. Note that this code also preconditions the gradient to go in the L_inf direction of steepest descent. EXPERIMENTAL: Do not use for adverserial examples if you need to be confident they a...
python
def unit_ball_L_inf(shape, precondition=True): """A tensorflow variable tranfomed to be constrained in a L_inf unit ball. Note that this code also preconditions the gradient to go in the L_inf direction of steepest descent. EXPERIMENTAL: Do not use for adverserial examples if you need to be confident they a...
[ "def", "unit_ball_L_inf", "(", "shape", ",", "precondition", "=", "True", ")", ":", "x", "=", "tf", ".", "Variable", "(", "tf", ".", "zeros", "(", "shape", ")", ")", "if", "precondition", ":", "return", "constrain_L_inf_precondition", "(", "x", ")", "els...
A tensorflow variable tranfomed to be constrained in a L_inf unit ball. Note that this code also preconditions the gradient to go in the L_inf direction of steepest descent. EXPERIMENTAL: Do not use for adverserial examples if you need to be confident they are strong attacks. We are not yet confident in this ...
[ "A", "tensorflow", "variable", "tranfomed", "to", "be", "constrained", "in", "a", "L_inf", "unit", "ball", "." ]
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/optvis/param/unit_balls.py#L106-L119
train
tensorflow/lucid
lucid/optvis/render.py
render_vis
def render_vis(model, objective_f, param_f=None, optimizer=None, transforms=None, thresholds=(512,), print_objectives=None, verbose=True, relu_gradient_override=True, use_fixed_seed=False): """Flexible optimization-base feature vis. There's a lot of ways one might wish to customize ot...
python
def render_vis(model, objective_f, param_f=None, optimizer=None, transforms=None, thresholds=(512,), print_objectives=None, verbose=True, relu_gradient_override=True, use_fixed_seed=False): """Flexible optimization-base feature vis. There's a lot of ways one might wish to customize ot...
[ "def", "render_vis", "(", "model", ",", "objective_f", ",", "param_f", "=", "None", ",", "optimizer", "=", "None", ",", "transforms", "=", "None", ",", "thresholds", "=", "(", "512", ",", ")", ",", "print_objectives", "=", "None", ",", "verbose", "=", ...
Flexible optimization-base feature vis. There's a lot of ways one might wish to customize otpimization-based feature visualization. It's hard to create an abstraction that stands up to all the things one might wish to try. This function probably can't do *everything* you want, but it's much more flexible th...
[ "Flexible", "optimization", "-", "base", "feature", "vis", "." ]
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/optvis/render.py#L44-L115
train
tensorflow/lucid
lucid/optvis/render.py
make_vis_T
def make_vis_T(model, objective_f, param_f=None, optimizer=None, transforms=None, relu_gradient_override=False): """Even more flexible optimization-base feature vis. This function is the inner core of render_vis(), and can be used when render_vis() isn't flexible enough. Unfortunately, it's a bit ...
python
def make_vis_T(model, objective_f, param_f=None, optimizer=None, transforms=None, relu_gradient_override=False): """Even more flexible optimization-base feature vis. This function is the inner core of render_vis(), and can be used when render_vis() isn't flexible enough. Unfortunately, it's a bit ...
[ "def", "make_vis_T", "(", "model", ",", "objective_f", ",", "param_f", "=", "None", ",", "optimizer", "=", "None", ",", "transforms", "=", "None", ",", "relu_gradient_override", "=", "False", ")", ":", "# pylint: disable=unused-variable", "t_image", "=", "make_t...
Even more flexible optimization-base feature vis. This function is the inner core of render_vis(), and can be used when render_vis() isn't flexible enough. Unfortunately, it's a bit more tedious to use: > with tf.Graph().as_default() as graph, tf.Session() as sess: > > T = make_vis_T(model, "mixed4a_p...
[ "Even", "more", "flexible", "optimization", "-", "base", "feature", "vis", "." ]
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/optvis/render.py#L118-L192
train
tensorflow/lucid
lucid/scratch/atlas_pipeline/grid.py
grid
def grid(metadata, layout, params): """ layout: numpy arrays x, y metadata: user-defined numpy arrays with metadata n_layer: number of cells in the layer (squared) n_tile: number of cells in the tile (squared) """ x = layout["x"] y = layout["y"] x_min = np.min(x) x_max = np.max(x) y_min = np.min(y...
python
def grid(metadata, layout, params): """ layout: numpy arrays x, y metadata: user-defined numpy arrays with metadata n_layer: number of cells in the layer (squared) n_tile: number of cells in the tile (squared) """ x = layout["x"] y = layout["y"] x_min = np.min(x) x_max = np.max(x) y_min = np.min(y...
[ "def", "grid", "(", "metadata", ",", "layout", ",", "params", ")", ":", "x", "=", "layout", "[", "\"x\"", "]", "y", "=", "layout", "[", "\"y\"", "]", "x_min", "=", "np", ".", "min", "(", "x", ")", "x_max", "=", "np", ".", "max", "(", "x", ")"...
layout: numpy arrays x, y metadata: user-defined numpy arrays with metadata n_layer: number of cells in the layer (squared) n_tile: number of cells in the tile (squared)
[ "layout", ":", "numpy", "arrays", "x", "y", "metadata", ":", "user", "-", "defined", "numpy", "arrays", "with", "metadata", "n_layer", ":", "number", "of", "cells", "in", "the", "layer", "(", "squared", ")", "n_tile", ":", "number", "of", "cells", "in", ...
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/scratch/atlas_pipeline/grid.py#L12-L68
train
tensorflow/lucid
lucid/scratch/atlas_pipeline/grid.py
write_grid_local
def write_grid_local(tiles, params): """ Write a file for each tile """ # TODO: this isn't being used right now, will need to be # ported to gfile if we want to keep it for ti,tj,tile in enumerate_tiles(tiles): filename = "{directory}/{name}/tile_{n_layer}_{n_tile}_{ti}_{tj}".format(ti=ti, tj=tj, **para...
python
def write_grid_local(tiles, params): """ Write a file for each tile """ # TODO: this isn't being used right now, will need to be # ported to gfile if we want to keep it for ti,tj,tile in enumerate_tiles(tiles): filename = "{directory}/{name}/tile_{n_layer}_{n_tile}_{ti}_{tj}".format(ti=ti, tj=tj, **para...
[ "def", "write_grid_local", "(", "tiles", ",", "params", ")", ":", "# TODO: this isn't being used right now, will need to be", "# ported to gfile if we want to keep it", "for", "ti", ",", "tj", ",", "tile", "in", "enumerate_tiles", "(", "tiles", ")", ":", "filename", "="...
Write a file for each tile
[ "Write", "a", "file", "for", "each", "tile" ]
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/scratch/atlas_pipeline/grid.py#L70-L84
train
tensorflow/lucid
lucid/scratch/atlas_pipeline/grid.py
enumerate_tiles
def enumerate_tiles(tiles): """ Convenience """ enumerated = [] for key in tiles.keys(): enumerated.append((key[0], key[1], tiles[key])) return enumerated
python
def enumerate_tiles(tiles): """ Convenience """ enumerated = [] for key in tiles.keys(): enumerated.append((key[0], key[1], tiles[key])) return enumerated
[ "def", "enumerate_tiles", "(", "tiles", ")", ":", "enumerated", "=", "[", "]", "for", "key", "in", "tiles", ".", "keys", "(", ")", ":", "enumerated", ".", "append", "(", "(", "key", "[", "0", "]", ",", "key", "[", "1", "]", ",", "tiles", "[", "...
Convenience
[ "Convenience" ]
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/scratch/atlas_pipeline/grid.py#L86-L93
train
tensorflow/lucid
lucid/misc/io/loading.py
_load_img
def _load_img(handle, target_dtype=np.float32, size=None, **kwargs): """Load image file as numpy array.""" image_pil = PIL.Image.open(handle, **kwargs) # resize the image to the requested size, if one was specified if size is not None: if len(size) > 2: size = size[:2] ...
python
def _load_img(handle, target_dtype=np.float32, size=None, **kwargs): """Load image file as numpy array.""" image_pil = PIL.Image.open(handle, **kwargs) # resize the image to the requested size, if one was specified if size is not None: if len(size) > 2: size = size[:2] ...
[ "def", "_load_img", "(", "handle", ",", "target_dtype", "=", "np", ".", "float32", ",", "size", "=", "None", ",", "*", "*", "kwargs", ")", ":", "image_pil", "=", "PIL", ".", "Image", ".", "open", "(", "handle", ",", "*", "*", "kwargs", ")", "# resi...
Load image file as numpy array.
[ "Load", "image", "file", "as", "numpy", "array", "." ]
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/misc/io/loading.py#L47-L78
train
tensorflow/lucid
lucid/misc/io/loading.py
_load_text
def _load_text(handle, split=False, encoding="utf-8"): """Load and decode a string.""" string = handle.read().decode(encoding) return string.splitlines() if split else string
python
def _load_text(handle, split=False, encoding="utf-8"): """Load and decode a string.""" string = handle.read().decode(encoding) return string.splitlines() if split else string
[ "def", "_load_text", "(", "handle", ",", "split", "=", "False", ",", "encoding", "=", "\"utf-8\"", ")", ":", "string", "=", "handle", ".", "read", "(", ")", ".", "decode", "(", "encoding", ")", "return", "string", ".", "splitlines", "(", ")", "if", "...
Load and decode a string.
[ "Load", "and", "decode", "a", "string", "." ]
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/misc/io/loading.py#L86-L89
train
tensorflow/lucid
lucid/misc/io/loading.py
_load_graphdef_protobuf
def _load_graphdef_protobuf(handle, **kwargs): """Load GraphDef from a binary proto file.""" # as_graph_def graph_def = tf.GraphDef.FromString(handle.read()) # check if this is a lucid-saved model # metadata = modelzoo.util.extract_metadata(graph_def) # if metadata is not None: # url = ha...
python
def _load_graphdef_protobuf(handle, **kwargs): """Load GraphDef from a binary proto file.""" # as_graph_def graph_def = tf.GraphDef.FromString(handle.read()) # check if this is a lucid-saved model # metadata = modelzoo.util.extract_metadata(graph_def) # if metadata is not None: # url = ha...
[ "def", "_load_graphdef_protobuf", "(", "handle", ",", "*", "*", "kwargs", ")", ":", "# as_graph_def", "graph_def", "=", "tf", ".", "GraphDef", ".", "FromString", "(", "handle", ".", "read", "(", ")", ")", "# check if this is a lucid-saved model", "# metadata = mod...
Load GraphDef from a binary proto file.
[ "Load", "GraphDef", "from", "a", "binary", "proto", "file", "." ]
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/misc/io/loading.py#L92-L104
train
tensorflow/lucid
lucid/misc/io/loading.py
load
def load(url_or_handle, cache=None, **kwargs): """Load a file. File format is inferred from url. File retrieval strategy is inferred from URL. Returned object type is inferred from url extension. Args: url_or_handle: a (reachable) URL, or an already open file handle Raises: RuntimeErr...
python
def load(url_or_handle, cache=None, **kwargs): """Load a file. File format is inferred from url. File retrieval strategy is inferred from URL. Returned object type is inferred from url extension. Args: url_or_handle: a (reachable) URL, or an already open file handle Raises: RuntimeErr...
[ "def", "load", "(", "url_or_handle", ",", "cache", "=", "None", ",", "*", "*", "kwargs", ")", ":", "ext", "=", "get_extension", "(", "url_or_handle", ")", "try", ":", "loader", "=", "loaders", "[", "ext", ".", "lower", "(", ")", "]", "message", "=", ...
Load a file. File format is inferred from url. File retrieval strategy is inferred from URL. Returned object type is inferred from url extension. Args: url_or_handle: a (reachable) URL, or an already open file handle Raises: RuntimeError: If file extension or URL is not supported.
[ "Load", "a", "file", "." ]
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/misc/io/loading.py#L120-L152
train
tensorflow/lucid
lucid/optvis/transform.py
crop_or_pad_to
def crop_or_pad_to(height, width): """Ensures the specified spatial shape by either padding or cropping. Meant to be used as a last transform for architectures insisting on a specific spatial shape of their inputs. """ def inner(t_image): return tf.image.resize_image_with_crop_or_pad(t_image...
python
def crop_or_pad_to(height, width): """Ensures the specified spatial shape by either padding or cropping. Meant to be used as a last transform for architectures insisting on a specific spatial shape of their inputs. """ def inner(t_image): return tf.image.resize_image_with_crop_or_pad(t_image...
[ "def", "crop_or_pad_to", "(", "height", ",", "width", ")", ":", "def", "inner", "(", "t_image", ")", ":", "return", "tf", ".", "image", ".", "resize_image_with_crop_or_pad", "(", "t_image", ",", "height", ",", "width", ")", "return", "inner" ]
Ensures the specified spatial shape by either padding or cropping. Meant to be used as a last transform for architectures insisting on a specific spatial shape of their inputs.
[ "Ensures", "the", "specified", "spatial", "shape", "by", "either", "padding", "or", "cropping", ".", "Meant", "to", "be", "used", "as", "a", "last", "transform", "for", "architectures", "insisting", "on", "a", "specific", "spatial", "shape", "of", "their", "...
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/optvis/transform.py#L154-L161
train
tensorflow/lucid
lucid/misc/io/serialize_array.py
_normalize_array
def _normalize_array(array, domain=(0, 1)): """Given an arbitrary rank-3 NumPy array, produce one representing an image. This ensures the resulting array has a dtype of uint8 and a domain of 0-255. Args: array: NumPy array representing the image domain: expected range of values in array, defaults ...
python
def _normalize_array(array, domain=(0, 1)): """Given an arbitrary rank-3 NumPy array, produce one representing an image. This ensures the resulting array has a dtype of uint8 and a domain of 0-255. Args: array: NumPy array representing the image domain: expected range of values in array, defaults ...
[ "def", "_normalize_array", "(", "array", ",", "domain", "=", "(", "0", ",", "1", ")", ")", ":", "# first copy the input so we're never mutating the user's data", "array", "=", "np", ".", "array", "(", "array", ")", "# squeeze helps both with batch=1 and B/W and PIL's mo...
Given an arbitrary rank-3 NumPy array, produce one representing an image. This ensures the resulting array has a dtype of uint8 and a domain of 0-255. Args: array: NumPy array representing the image domain: expected range of values in array, defaults to (0, 1), if explicitly set to None will use the...
[ "Given", "an", "arbitrary", "rank", "-", "3", "NumPy", "array", "produce", "one", "representing", "an", "image", "." ]
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/misc/io/serialize_array.py#L31-L77
train
tensorflow/lucid
lucid/misc/io/serialize_array.py
_serialize_normalized_array
def _serialize_normalized_array(array, fmt='png', quality=70): """Given a normalized array, returns byte representation of image encoding. Args: array: NumPy array of dtype uint8 and range 0 to 255 fmt: string describing desired file format, defaults to 'png' quality: specifies compression quality from...
python
def _serialize_normalized_array(array, fmt='png', quality=70): """Given a normalized array, returns byte representation of image encoding. Args: array: NumPy array of dtype uint8 and range 0 to 255 fmt: string describing desired file format, defaults to 'png' quality: specifies compression quality from...
[ "def", "_serialize_normalized_array", "(", "array", ",", "fmt", "=", "'png'", ",", "quality", "=", "70", ")", ":", "dtype", "=", "array", ".", "dtype", "assert", "np", ".", "issubdtype", "(", "dtype", ",", "np", ".", "unsignedinteger", ")", "assert", "np...
Given a normalized array, returns byte representation of image encoding. Args: array: NumPy array of dtype uint8 and range 0 to 255 fmt: string describing desired file format, defaults to 'png' quality: specifies compression quality from 0 to 100 for lossy formats Returns: image data as BytesIO bu...
[ "Given", "a", "normalized", "array", "returns", "byte", "representation", "of", "image", "encoding", "." ]
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/misc/io/serialize_array.py#L80-L101
train
tensorflow/lucid
lucid/misc/io/serialize_array.py
serialize_array
def serialize_array(array, domain=(0, 1), fmt='png', quality=70): """Given an arbitrary rank-3 NumPy array, returns the byte representation of the encoded image. Args: array: NumPy array of dtype uint8 and range 0 to 255 domain: expected range of values in array, see `_normalize_array()` fmt: string ...
python
def serialize_array(array, domain=(0, 1), fmt='png', quality=70): """Given an arbitrary rank-3 NumPy array, returns the byte representation of the encoded image. Args: array: NumPy array of dtype uint8 and range 0 to 255 domain: expected range of values in array, see `_normalize_array()` fmt: string ...
[ "def", "serialize_array", "(", "array", ",", "domain", "=", "(", "0", ",", "1", ")", ",", "fmt", "=", "'png'", ",", "quality", "=", "70", ")", ":", "normalized", "=", "_normalize_array", "(", "array", ",", "domain", "=", "domain", ")", "return", "_se...
Given an arbitrary rank-3 NumPy array, returns the byte representation of the encoded image. Args: array: NumPy array of dtype uint8 and range 0 to 255 domain: expected range of values in array, see `_normalize_array()` fmt: string describing desired file format, defaults to 'png' quality: specifie...
[ "Given", "an", "arbitrary", "rank", "-", "3", "NumPy", "array", "returns", "the", "byte", "representation", "of", "the", "encoded", "image", "." ]
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/misc/io/serialize_array.py#L104-L118
train
tensorflow/lucid
lucid/misc/io/serialize_array.py
array_to_jsbuffer
def array_to_jsbuffer(array): """Serialize 1d NumPy array to JS TypedArray. Data is serialized to base64-encoded string, which is much faster and memory-efficient than json list serialization. Args: array: 1d NumPy array, dtype must be one of JS_ARRAY_TYPES. Returns: JS code that evaluates to a Typ...
python
def array_to_jsbuffer(array): """Serialize 1d NumPy array to JS TypedArray. Data is serialized to base64-encoded string, which is much faster and memory-efficient than json list serialization. Args: array: 1d NumPy array, dtype must be one of JS_ARRAY_TYPES. Returns: JS code that evaluates to a Typ...
[ "def", "array_to_jsbuffer", "(", "array", ")", ":", "if", "array", ".", "ndim", "!=", "1", ":", "raise", "TypeError", "(", "'Only 1d arrays can be converted JS TypedArray.'", ")", "if", "array", ".", "dtype", ".", "name", "not", "in", "JS_ARRAY_TYPES", ":", "r...
Serialize 1d NumPy array to JS TypedArray. Data is serialized to base64-encoded string, which is much faster and memory-efficient than json list serialization. Args: array: 1d NumPy array, dtype must be one of JS_ARRAY_TYPES. Returns: JS code that evaluates to a TypedArray as string. Raises: T...
[ "Serialize", "1d", "NumPy", "array", "to", "JS", "TypedArray", "." ]
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/misc/io/serialize_array.py#L126-L161
train
tensorflow/lucid
lucid/misc/channel_reducer.py
ChannelReducer._apply_flat
def _apply_flat(cls, f, acts): """Utility for applying f to inner dimension of acts. Flattens acts into a 2D tensor, applies f, then unflattens so that all dimesnions except innermost are unchanged. """ orig_shape = acts.shape acts_flat = acts.reshape([-1, acts.shape[-1]]) new_flat = f(acts...
python
def _apply_flat(cls, f, acts): """Utility for applying f to inner dimension of acts. Flattens acts into a 2D tensor, applies f, then unflattens so that all dimesnions except innermost are unchanged. """ orig_shape = acts.shape acts_flat = acts.reshape([-1, acts.shape[-1]]) new_flat = f(acts...
[ "def", "_apply_flat", "(", "cls", ",", "f", ",", "acts", ")", ":", "orig_shape", "=", "acts", ".", "shape", "acts_flat", "=", "acts", ".", "reshape", "(", "[", "-", "1", ",", "acts", ".", "shape", "[", "-", "1", "]", "]", ")", "new_flat", "=", ...
Utility for applying f to inner dimension of acts. Flattens acts into a 2D tensor, applies f, then unflattens so that all dimesnions except innermost are unchanged.
[ "Utility", "for", "applying", "f", "to", "inner", "dimension", "of", "acts", "." ]
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/misc/channel_reducer.py#L52-L64
train
tensorflow/lucid
lucid/optvis/style.py
StyleLoss.set_style
def set_style(self, input_feeds): """Set target style variables. Expected usage: style_loss = StyleLoss(style_layers) ... init_op = tf.global_variables_initializer() init_op.run() feeds = {... session.run() 'feeds' argument that will make 'style_layers' ...
python
def set_style(self, input_feeds): """Set target style variables. Expected usage: style_loss = StyleLoss(style_layers) ... init_op = tf.global_variables_initializer() init_op.run() feeds = {... session.run() 'feeds' argument that will make 'style_layers' ...
[ "def", "set_style", "(", "self", ",", "input_feeds", ")", ":", "sess", "=", "tf", ".", "get_default_session", "(", ")", "computed", "=", "sess", ".", "run", "(", "self", ".", "input_grams", ",", "input_feeds", ")", "for", "v", ",", "g", "in", "zip", ...
Set target style variables. Expected usage: style_loss = StyleLoss(style_layers) ... init_op = tf.global_variables_initializer() init_op.run() feeds = {... session.run() 'feeds' argument that will make 'style_layers' tensors evaluate to activation values of ...
[ "Set", "target", "style", "variables", ".", "Expected", "usage", ":", "style_loss", "=", "StyleLoss", "(", "style_layers", ")", "...", "init_op", "=", "tf", ".", "global_variables_initializer", "()", "init_op", ".", "run", "()", "feeds", "=", "{", "...", "se...
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/optvis/style.py#L74-L90
train
tensorflow/lucid
lucid/misc/io/showing.py
_image_url
def _image_url(array, fmt='png', mode="data", quality=90, domain=None): """Create a data URL representing an image from a PIL.Image. Args: image: a numpy mode: presently only supports "data" for data URL Returns: URL representing image """ supported_modes = ("data") if mode not in supported_mo...
python
def _image_url(array, fmt='png', mode="data", quality=90, domain=None): """Create a data URL representing an image from a PIL.Image. Args: image: a numpy mode: presently only supports "data" for data URL Returns: URL representing image """ supported_modes = ("data") if mode not in supported_mo...
[ "def", "_image_url", "(", "array", ",", "fmt", "=", "'png'", ",", "mode", "=", "\"data\"", ",", "quality", "=", "90", ",", "domain", "=", "None", ")", ":", "supported_modes", "=", "(", "\"data\"", ")", "if", "mode", "not", "in", "supported_modes", ":",...
Create a data URL representing an image from a PIL.Image. Args: image: a numpy mode: presently only supports "data" for data URL Returns: URL representing image
[ "Create", "a", "data", "URL", "representing", "an", "image", "from", "a", "PIL", ".", "Image", "." ]
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/misc/io/showing.py#L39-L56
train
tensorflow/lucid
lucid/misc/io/showing.py
image
def image(array, domain=None, width=None, format='png', **kwargs): """Display an image. Args: array: NumPy array representing the image fmt: Image format e.g. png, jpeg domain: Domain of pixel values, inferred from min & max values if None w: width of output image, scaled using nearest neighbor int...
python
def image(array, domain=None, width=None, format='png', **kwargs): """Display an image. Args: array: NumPy array representing the image fmt: Image format e.g. png, jpeg domain: Domain of pixel values, inferred from min & max values if None w: width of output image, scaled using nearest neighbor int...
[ "def", "image", "(", "array", ",", "domain", "=", "None", ",", "width", "=", "None", ",", "format", "=", "'png'", ",", "*", "*", "kwargs", ")", ":", "image_data", "=", "serialize_array", "(", "array", ",", "fmt", "=", "format", ",", "domain", "=", ...
Display an image. Args: array: NumPy array representing the image fmt: Image format e.g. png, jpeg domain: Domain of pixel values, inferred from min & max values if None w: width of output image, scaled using nearest neighbor interpolation. size unchanged if None
[ "Display", "an", "image", "." ]
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/misc/io/showing.py#L62-L75
train
tensorflow/lucid
lucid/misc/io/showing.py
images
def images(arrays, labels=None, domain=None, w=None): """Display a list of images with optional labels. Args: arrays: A list of NumPy arrays representing images labels: A list of strings to label each image. Defaults to show index if None domain: Domain of pixel values, inferred from min & max va...
python
def images(arrays, labels=None, domain=None, w=None): """Display a list of images with optional labels. Args: arrays: A list of NumPy arrays representing images labels: A list of strings to label each image. Defaults to show index if None domain: Domain of pixel values, inferred from min & max va...
[ "def", "images", "(", "arrays", ",", "labels", "=", "None", ",", "domain", "=", "None", ",", "w", "=", "None", ")", ":", "s", "=", "'<div style=\"display: flex; flex-direction: row;\">'", "for", "i", ",", "array", "in", "enumerate", "(", "arrays", ")", ":"...
Display a list of images with optional labels. Args: arrays: A list of NumPy arrays representing images labels: A list of strings to label each image. Defaults to show index if None domain: Domain of pixel values, inferred from min & max values if None w: width of output image, scaled using nea...
[ "Display", "a", "list", "of", "images", "with", "optional", "labels", "." ]
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/misc/io/showing.py#L78-L99
train
tensorflow/lucid
lucid/misc/io/showing.py
show
def show(thing, domain=(0, 1), **kwargs): """Display a nupmy array without having to specify what it represents. This module will attempt to infer how to display your tensor based on its rank, shape and dtype. rank 4 tensors will be displayed as image grids, rank 2 and 3 tensors as images. """ if isinstanc...
python
def show(thing, domain=(0, 1), **kwargs): """Display a nupmy array without having to specify what it represents. This module will attempt to infer how to display your tensor based on its rank, shape and dtype. rank 4 tensors will be displayed as image grids, rank 2 and 3 tensors as images. """ if isinstanc...
[ "def", "show", "(", "thing", ",", "domain", "=", "(", "0", ",", "1", ")", ",", "*", "*", "kwargs", ")", ":", "if", "isinstance", "(", "thing", ",", "np", ".", "ndarray", ")", ":", "rank", "=", "len", "(", "thing", ".", "shape", ")", "if", "ra...
Display a nupmy array without having to specify what it represents. This module will attempt to infer how to display your tensor based on its rank, shape and dtype. rank 4 tensors will be displayed as image grids, rank 2 and 3 tensors as images.
[ "Display", "a", "nupmy", "array", "without", "having", "to", "specify", "what", "it", "represents", "." ]
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/misc/io/showing.py#L102-L125
train
tensorflow/lucid
lucid/misc/io/showing.py
_strip_consts
def _strip_consts(graph_def, max_const_size=32): """Strip large constant values from graph_def. This is mostly a utility function for graph(), and also originates here: https://github.com/tensorflow/tensorflow/blob/master/tensorflow/examples/tutorials/deepdream/deepdream.ipynb """ strip_def = tf.Gr...
python
def _strip_consts(graph_def, max_const_size=32): """Strip large constant values from graph_def. This is mostly a utility function for graph(), and also originates here: https://github.com/tensorflow/tensorflow/blob/master/tensorflow/examples/tutorials/deepdream/deepdream.ipynb """ strip_def = tf.Gr...
[ "def", "_strip_consts", "(", "graph_def", ",", "max_const_size", "=", "32", ")", ":", "strip_def", "=", "tf", ".", "GraphDef", "(", ")", "for", "n0", "in", "graph_def", ".", "node", ":", "n", "=", "strip_def", ".", "node", ".", "add", "(", ")", "n", ...
Strip large constant values from graph_def. This is mostly a utility function for graph(), and also originates here: https://github.com/tensorflow/tensorflow/blob/master/tensorflow/examples/tutorials/deepdream/deepdream.ipynb
[ "Strip", "large", "constant", "values", "from", "graph_def", "." ]
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/misc/io/showing.py#L272-L287
train
tensorflow/lucid
lucid/misc/io/showing.py
graph
def graph(graph_def, max_const_size=32): """Visualize a TensorFlow graph. This function was originally found in this notebook (also Apache licensed): https://github.com/tensorflow/tensorflow/blob/master/tensorflow/examples/tutorials/deepdream/deepdream.ipynb """ if hasattr(graph_def, 'as_graph_def'...
python
def graph(graph_def, max_const_size=32): """Visualize a TensorFlow graph. This function was originally found in this notebook (also Apache licensed): https://github.com/tensorflow/tensorflow/blob/master/tensorflow/examples/tutorials/deepdream/deepdream.ipynb """ if hasattr(graph_def, 'as_graph_def'...
[ "def", "graph", "(", "graph_def", ",", "max_const_size", "=", "32", ")", ":", "if", "hasattr", "(", "graph_def", ",", "'as_graph_def'", ")", ":", "graph_def", "=", "graph_def", ".", "as_graph_def", "(", ")", "strip_def", "=", "_strip_consts", "(", "graph_def...
Visualize a TensorFlow graph. This function was originally found in this notebook (also Apache licensed): https://github.com/tensorflow/tensorflow/blob/master/tensorflow/examples/tutorials/deepdream/deepdream.ipynb
[ "Visualize", "a", "TensorFlow", "graph", "." ]
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/misc/io/showing.py#L290-L314
train
tensorflow/lucid
lucid/misc/ndimage_utils.py
resize
def resize(image, target_size, **kwargs): """Resize an ndarray image of rank 3 or 4. target_size can be a tuple `(width, height)` or scalar `width`.""" if isinstance(target_size, int): target_size = (target_size, target_size) if not isinstance(target_size, (list, tuple, np.ndarray)): m...
python
def resize(image, target_size, **kwargs): """Resize an ndarray image of rank 3 or 4. target_size can be a tuple `(width, height)` or scalar `width`.""" if isinstance(target_size, int): target_size = (target_size, target_size) if not isinstance(target_size, (list, tuple, np.ndarray)): m...
[ "def", "resize", "(", "image", ",", "target_size", ",", "*", "*", "kwargs", ")", ":", "if", "isinstance", "(", "target_size", ",", "int", ")", ":", "target_size", "=", "(", "target_size", ",", "target_size", ")", "if", "not", "isinstance", "(", "target_s...
Resize an ndarray image of rank 3 or 4. target_size can be a tuple `(width, height)` or scalar `width`.
[ "Resize", "an", "ndarray", "image", "of", "rank", "3", "or", "4", ".", "target_size", "can", "be", "a", "tuple", "(", "width", "height", ")", "or", "scalar", "width", "." ]
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/misc/ndimage_utils.py#L20-L48
train
tensorflow/lucid
lucid/misc/ndimage_utils.py
composite
def composite( background_image, foreground_image, foreground_width_ratio=0.25, foreground_position=(0.0, 0.0), ): """Takes two images and composites them.""" if foreground_width_ratio <= 0: return background_image composite = background_image.copy() width = int(foreground_widt...
python
def composite( background_image, foreground_image, foreground_width_ratio=0.25, foreground_position=(0.0, 0.0), ): """Takes two images and composites them.""" if foreground_width_ratio <= 0: return background_image composite = background_image.copy() width = int(foreground_widt...
[ "def", "composite", "(", "background_image", ",", "foreground_image", ",", "foreground_width_ratio", "=", "0.25", ",", "foreground_position", "=", "(", "0.0", ",", "0.0", ")", ",", ")", ":", "if", "foreground_width_ratio", "<=", "0", ":", "return", "background_i...
Takes two images and composites them.
[ "Takes", "two", "images", "and", "composites", "them", "." ]
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/misc/ndimage_utils.py#L51-L73
train
tensorflow/lucid
lucid/optvis/param/lowres.py
lowres_tensor
def lowres_tensor(shape, underlying_shape, offset=None, sd=None): """Produces a tensor paramaterized by a interpolated lower resolution tensor. This is like what is done in a laplacian pyramid, but a bit more general. It can be a powerful way to describe images. Args: shape: desired shape of resulting t...
python
def lowres_tensor(shape, underlying_shape, offset=None, sd=None): """Produces a tensor paramaterized by a interpolated lower resolution tensor. This is like what is done in a laplacian pyramid, but a bit more general. It can be a powerful way to describe images. Args: shape: desired shape of resulting t...
[ "def", "lowres_tensor", "(", "shape", ",", "underlying_shape", ",", "offset", "=", "None", ",", "sd", "=", "None", ")", ":", "sd", "=", "sd", "or", "0.01", "init_val", "=", "sd", "*", "np", ".", "random", ".", "randn", "(", "*", "underlying_shape", "...
Produces a tensor paramaterized by a interpolated lower resolution tensor. This is like what is done in a laplacian pyramid, but a bit more general. It can be a powerful way to describe images. Args: shape: desired shape of resulting tensor underlying_shape: shape of the tensor being resized into final ...
[ "Produces", "a", "tensor", "paramaterized", "by", "a", "interpolated", "lower", "resolution", "tensor", "." ]
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/optvis/param/lowres.py#L24-L66
train
tensorflow/lucid
lucid/misc/tfutil.py
create_session
def create_session(target='', timeout_sec=10): '''Create an intractive TensorFlow session. Helper function that creates TF session that uses growing GPU memory allocation and opration timeout. 'allow_growth' flag prevents TF from allocating the whole GPU memory an once, which is useful when having multiple p...
python
def create_session(target='', timeout_sec=10): '''Create an intractive TensorFlow session. Helper function that creates TF session that uses growing GPU memory allocation and opration timeout. 'allow_growth' flag prevents TF from allocating the whole GPU memory an once, which is useful when having multiple p...
[ "def", "create_session", "(", "target", "=", "''", ",", "timeout_sec", "=", "10", ")", ":", "graph", "=", "tf", ".", "Graph", "(", ")", "config", "=", "tf", ".", "ConfigProto", "(", ")", "config", ".", "gpu_options", ".", "allow_growth", "=", "True", ...
Create an intractive TensorFlow session. Helper function that creates TF session that uses growing GPU memory allocation and opration timeout. 'allow_growth' flag prevents TF from allocating the whole GPU memory an once, which is useful when having multiple python sessions sharing the same GPU.
[ "Create", "an", "intractive", "TensorFlow", "session", "." ]
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/misc/tfutil.py#L19-L31
train
tensorflow/lucid
lucid/misc/io/reading.py
read
def read(url, encoding=None, cache=None, mode="rb"): """Read from any URL. Internally differentiates between URLs supported by tf.gfile, such as URLs with the Google Cloud Storage scheme ('gs://...') or local paths, and HTTP URLs. This way users don't need to know about the underlying fetch mechanism. ...
python
def read(url, encoding=None, cache=None, mode="rb"): """Read from any URL. Internally differentiates between URLs supported by tf.gfile, such as URLs with the Google Cloud Storage scheme ('gs://...') or local paths, and HTTP URLs. This way users don't need to know about the underlying fetch mechanism. ...
[ "def", "read", "(", "url", ",", "encoding", "=", "None", ",", "cache", "=", "None", ",", "mode", "=", "\"rb\"", ")", ":", "with", "read_handle", "(", "url", ",", "cache", ",", "mode", "=", "mode", ")", "as", "handle", ":", "data", "=", "handle", ...
Read from any URL. Internally differentiates between URLs supported by tf.gfile, such as URLs with the Google Cloud Storage scheme ('gs://...') or local paths, and HTTP URLs. This way users don't need to know about the underlying fetch mechanism. Args: url: a URL including scheme or a local pa...
[ "Read", "from", "any", "URL", "." ]
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/misc/io/reading.py#L48-L71
train
tensorflow/lucid
lucid/misc/io/reading.py
read_handle
def read_handle(url, cache=None, mode="rb"): """Read from any URL with a file handle. Use this to get a handle to a file rather than eagerly load the data: ``` with read_handle(url) as handle: result = something.load(handle) result.do_something() ``` When program execution leaves th...
python
def read_handle(url, cache=None, mode="rb"): """Read from any URL with a file handle. Use this to get a handle to a file rather than eagerly load the data: ``` with read_handle(url) as handle: result = something.load(handle) result.do_something() ``` When program execution leaves th...
[ "def", "read_handle", "(", "url", ",", "cache", "=", "None", ",", "mode", "=", "\"rb\"", ")", ":", "scheme", "=", "urlparse", "(", "url", ")", ".", "scheme", "if", "cache", "==", "'purge'", ":", "_purge_cached", "(", "url", ")", "cache", "=", "None",...
Read from any URL with a file handle. Use this to get a handle to a file rather than eagerly load the data: ``` with read_handle(url) as handle: result = something.load(handle) result.do_something() ``` When program execution leaves this `with` block, the handle will be closed autom...
[ "Read", "from", "any", "URL", "with", "a", "file", "handle", "." ]
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/misc/io/reading.py#L75-L118
train
tensorflow/lucid
lucid/misc/io/reading.py
local_cache_path
def local_cache_path(remote_url): """Returns the path that remote_url would be cached at locally.""" local_name = RESERVED_PATH_CHARS.sub("_", remote_url) return os.path.join(gettempdir(), local_name)
python
def local_cache_path(remote_url): """Returns the path that remote_url would be cached at locally.""" local_name = RESERVED_PATH_CHARS.sub("_", remote_url) return os.path.join(gettempdir(), local_name)
[ "def", "local_cache_path", "(", "remote_url", ")", ":", "local_name", "=", "RESERVED_PATH_CHARS", ".", "sub", "(", "\"_\"", ",", "remote_url", ")", "return", "os", ".", "path", ".", "join", "(", "gettempdir", "(", ")", ",", "local_name", ")" ]
Returns the path that remote_url would be cached at locally.
[ "Returns", "the", "path", "that", "remote_url", "would", "be", "cached", "at", "locally", "." ]
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/misc/io/reading.py#L142-L145
train
tensorflow/lucid
lucid/optvis/param/cppn.py
cppn
def cppn( width, batch=1, num_output_channels=3, num_hidden_channels=24, num_layers=8, activation_func=_composite_activation, normalize=False, ): """Compositional Pattern Producing Network Args: width: width of resulting image, equals height batch: batch dimension of out...
python
def cppn( width, batch=1, num_output_channels=3, num_hidden_channels=24, num_layers=8, activation_func=_composite_activation, normalize=False, ): """Compositional Pattern Producing Network Args: width: width of resulting image, equals height batch: batch dimension of out...
[ "def", "cppn", "(", "width", ",", "batch", "=", "1", ",", "num_output_channels", "=", "3", ",", "num_hidden_channels", "=", "24", ",", "num_layers", "=", "8", ",", "activation_func", "=", "_composite_activation", ",", "normalize", "=", "False", ",", ")", "...
Compositional Pattern Producing Network Args: width: width of resulting image, equals height batch: batch dimension of output, note that all params share the same weights! num_output_channels: num_hidden_channels: num_layers: activation_func: normalize: Returns: ...
[ "Compositional", "Pattern", "Producing", "Network" ]
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/optvis/param/cppn.py#L54-L100
train
tensorflow/lucid
lucid/modelzoo/nets_factory.py
get_model
def get_model(name): """Returns a model instance such as `model = vision_models.InceptionV1()`. In the future may be expanded to filter by additional criteria, such as architecture, dataset, and task the model was trained on. Args: name: The name of the model, as given by the class name in vision_...
python
def get_model(name): """Returns a model instance such as `model = vision_models.InceptionV1()`. In the future may be expanded to filter by additional criteria, such as architecture, dataset, and task the model was trained on. Args: name: The name of the model, as given by the class name in vision_...
[ "def", "get_model", "(", "name", ")", ":", "if", "name", "not", "in", "models_map", ":", "candidates", "=", "filter", "(", "lambda", "key", ":", "name", "in", "key", ",", "models_map", ".", "keys", "(", ")", ")", "candidates_string", "=", "\", \"", "."...
Returns a model instance such as `model = vision_models.InceptionV1()`. In the future may be expanded to filter by additional criteria, such as architecture, dataset, and task the model was trained on. Args: name: The name of the model, as given by the class name in vision_models. Returns: A...
[ "Returns", "a", "model", "instance", "such", "as", "model", "=", "vision_models", ".", "InceptionV1", "()", ".", "In", "the", "future", "may", "be", "expanded", "to", "filter", "by", "additional", "criteria", "such", "as", "architecture", "dataset", "and", "...
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/modelzoo/nets_factory.py#L44-L68
train
tensorflow/lucid
lucid/recipes/activation_atlas/main.py
activation_atlas
def activation_atlas( model, layer, grid_size=10, icon_size=96, number_activations=NUMBER_OF_AVAILABLE_SAMPLES, icon_batch_size=32, verbose=False, ): """Renders an Activation Atlas of the given model's layer.""" activations = layer.activations[:number_activations, ...] layout, =...
python
def activation_atlas( model, layer, grid_size=10, icon_size=96, number_activations=NUMBER_OF_AVAILABLE_SAMPLES, icon_batch_size=32, verbose=False, ): """Renders an Activation Atlas of the given model's layer.""" activations = layer.activations[:number_activations, ...] layout, =...
[ "def", "activation_atlas", "(", "model", ",", "layer", ",", "grid_size", "=", "10", ",", "icon_size", "=", "96", ",", "number_activations", "=", "NUMBER_OF_AVAILABLE_SAMPLES", ",", "icon_batch_size", "=", "32", ",", "verbose", "=", "False", ",", ")", ":", "a...
Renders an Activation Atlas of the given model's layer.
[ "Renders", "an", "Activation", "Atlas", "of", "the", "given", "model", "s", "layer", "." ]
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/recipes/activation_atlas/main.py#L30-L54
train
tensorflow/lucid
lucid/recipes/activation_atlas/main.py
aligned_activation_atlas
def aligned_activation_atlas( model1, layer1, model2, layer2, grid_size=10, icon_size=80, num_steps=1024, whiten_layers=True, number_activations=NUMBER_OF_AVAILABLE_SAMPLES, icon_batch_size=32, verbose=False, ): """Renders two aligned Activation Atlases of the given model...
python
def aligned_activation_atlas( model1, layer1, model2, layer2, grid_size=10, icon_size=80, num_steps=1024, whiten_layers=True, number_activations=NUMBER_OF_AVAILABLE_SAMPLES, icon_batch_size=32, verbose=False, ): """Renders two aligned Activation Atlases of the given model...
[ "def", "aligned_activation_atlas", "(", "model1", ",", "layer1", ",", "model2", ",", "layer2", ",", "grid_size", "=", "10", ",", "icon_size", "=", "80", ",", "num_steps", "=", "1024", ",", "whiten_layers", "=", "True", ",", "number_activations", "=", "NUMBER...
Renders two aligned Activation Atlases of the given models' layers. Returns a generator of the two atlasses, and a nested generator for intermediate atlasses while they're being rendered.
[ "Renders", "two", "aligned", "Activation", "Atlases", "of", "the", "given", "models", "layers", "." ]
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/recipes/activation_atlas/main.py#L57-L100
train
tensorflow/lucid
lucid/recipes/activation_atlas/main.py
_combine_activations
def _combine_activations( layer1, layer2, activations1=None, activations2=None, mode=ActivationTranslation.BIDIRECTIONAL, number_activations=NUMBER_OF_AVAILABLE_SAMPLES, ): """Given two layers, combines their activations according to mode. ActivationTranslation.ONE_TO_TWO: Transla...
python
def _combine_activations( layer1, layer2, activations1=None, activations2=None, mode=ActivationTranslation.BIDIRECTIONAL, number_activations=NUMBER_OF_AVAILABLE_SAMPLES, ): """Given two layers, combines their activations according to mode. ActivationTranslation.ONE_TO_TWO: Transla...
[ "def", "_combine_activations", "(", "layer1", ",", "layer2", ",", "activations1", "=", "None", ",", "activations2", "=", "None", ",", "mode", "=", "ActivationTranslation", ".", "BIDIRECTIONAL", ",", "number_activations", "=", "NUMBER_OF_AVAILABLE_SAMPLES", ",", ")",...
Given two layers, combines their activations according to mode. ActivationTranslation.ONE_TO_TWO: Translate activations of layer1 into the space of layer2, and return a tuple of the translated activations and the original layer2 activations. ActivationTranslation.BIDIRECTIONAL: Translate act...
[ "Given", "two", "layers", "combines", "their", "activations", "according", "to", "mode", "." ]
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/recipes/activation_atlas/main.py#L111-L146
train
tensorflow/lucid
lucid/recipes/activation_atlas/main.py
bin_laid_out_activations
def bin_laid_out_activations(layout, activations, grid_size, threshold=5): """Given a layout and activations, overlays a grid on the layout and returns averaged activations for each grid cell. If a cell contains less than `threshold` activations it will be discarded, so the number of returned data is variab...
python
def bin_laid_out_activations(layout, activations, grid_size, threshold=5): """Given a layout and activations, overlays a grid on the layout and returns averaged activations for each grid cell. If a cell contains less than `threshold` activations it will be discarded, so the number of returned data is variab...
[ "def", "bin_laid_out_activations", "(", "layout", ",", "activations", ",", "grid_size", ",", "threshold", "=", "5", ")", ":", "assert", "layout", ".", "shape", "[", "0", "]", "==", "activations", ".", "shape", "[", "0", "]", "# calculate which grid cells each ...
Given a layout and activations, overlays a grid on the layout and returns averaged activations for each grid cell. If a cell contains less than `threshold` activations it will be discarded, so the number of returned data is variable.
[ "Given", "a", "layout", "and", "activations", "overlays", "a", "grid", "on", "the", "layout", "and", "returns", "averaged", "activations", "for", "each", "grid", "cell", ".", "If", "a", "cell", "contains", "less", "than", "threshold", "activations", "it", "w...
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/recipes/activation_atlas/main.py#L149-L180
train
tensorflow/lucid
lucid/modelzoo/util.py
load_graphdef
def load_graphdef(model_url, reset_device=True): """Load GraphDef from a binary proto file.""" graph_def = load(model_url) if reset_device: for n in graph_def.node: n.device = "" return graph_def
python
def load_graphdef(model_url, reset_device=True): """Load GraphDef from a binary proto file.""" graph_def = load(model_url) if reset_device: for n in graph_def.node: n.device = "" return graph_def
[ "def", "load_graphdef", "(", "model_url", ",", "reset_device", "=", "True", ")", ":", "graph_def", "=", "load", "(", "model_url", ")", "if", "reset_device", ":", "for", "n", "in", "graph_def", ".", "node", ":", "n", ".", "device", "=", "\"\"", "return", ...
Load GraphDef from a binary proto file.
[ "Load", "GraphDef", "from", "a", "binary", "proto", "file", "." ]
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/modelzoo/util.py#L39-L47
train
tensorflow/lucid
lucid/modelzoo/util.py
forget_xy
def forget_xy(t): """Ignore sizes of dimensions (1, 2) of a 4d tensor in shape inference. This allows using smaller input sizes, which create an invalid graph at higher layers (for example because a spatial dimension becomes smaller than a conv filter) when we only use early parts of it. """ shape = (t.sha...
python
def forget_xy(t): """Ignore sizes of dimensions (1, 2) of a 4d tensor in shape inference. This allows using smaller input sizes, which create an invalid graph at higher layers (for example because a spatial dimension becomes smaller than a conv filter) when we only use early parts of it. """ shape = (t.sha...
[ "def", "forget_xy", "(", "t", ")", ":", "shape", "=", "(", "t", ".", "shape", "[", "0", "]", ",", "None", ",", "None", ",", "t", ".", "shape", "[", "3", "]", ")", "return", "tf", ".", "placeholder_with_default", "(", "t", ",", "shape", ")" ]
Ignore sizes of dimensions (1, 2) of a 4d tensor in shape inference. This allows using smaller input sizes, which create an invalid graph at higher layers (for example because a spatial dimension becomes smaller than a conv filter) when we only use early parts of it.
[ "Ignore", "sizes", "of", "dimensions", "(", "1", "2", ")", "of", "a", "4d", "tensor", "in", "shape", "inference", "." ]
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/modelzoo/util.py#L50-L58
train
tensorflow/lucid
lucid/modelzoo/util.py
frozen_default_graph_def
def frozen_default_graph_def(input_node_names, output_node_names): """Return frozen and simplified graph_def of default graph.""" sess = tf.get_default_session() input_graph_def = tf.get_default_graph().as_graph_def() pruned_graph = tf.graph_util.remove_training_nodes( input_graph_def, protected_nodes=(...
python
def frozen_default_graph_def(input_node_names, output_node_names): """Return frozen and simplified graph_def of default graph.""" sess = tf.get_default_session() input_graph_def = tf.get_default_graph().as_graph_def() pruned_graph = tf.graph_util.remove_training_nodes( input_graph_def, protected_nodes=(...
[ "def", "frozen_default_graph_def", "(", "input_node_names", ",", "output_node_names", ")", ":", "sess", "=", "tf", ".", "get_default_session", "(", ")", "input_graph_def", "=", "tf", ".", "get_default_graph", "(", ")", ".", "as_graph_def", "(", ")", "pruned_graph"...
Return frozen and simplified graph_def of default graph.
[ "Return", "frozen", "and", "simplified", "graph_def", "of", "default", "graph", "." ]
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/modelzoo/util.py#L61-L84
train
tensorflow/lucid
lucid/modelzoo/util.py
infuse_metadata
def infuse_metadata(graph_def, info): """Embed meta data as a string constant in a TF graph. This function takes info, converts it into json, and embeds it in graph_def as a constant op called `__lucid_metadata_json`. """ temp_graph = tf.Graph() with temp_graph.as_default(): tf.constant(json.dumps(info...
python
def infuse_metadata(graph_def, info): """Embed meta data as a string constant in a TF graph. This function takes info, converts it into json, and embeds it in graph_def as a constant op called `__lucid_metadata_json`. """ temp_graph = tf.Graph() with temp_graph.as_default(): tf.constant(json.dumps(info...
[ "def", "infuse_metadata", "(", "graph_def", ",", "info", ")", ":", "temp_graph", "=", "tf", ".", "Graph", "(", ")", "with", "temp_graph", ".", "as_default", "(", ")", ":", "tf", ".", "constant", "(", "json", ".", "dumps", "(", "info", ",", "cls", "="...
Embed meta data as a string constant in a TF graph. This function takes info, converts it into json, and embeds it in graph_def as a constant op called `__lucid_metadata_json`.
[ "Embed", "meta", "data", "as", "a", "string", "constant", "in", "a", "TF", "graph", "." ]
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/modelzoo/util.py#L89-L99
train
tensorflow/lucid
lucid/modelzoo/util.py
extract_metadata
def extract_metadata(graph_def): """Attempt to extract meta data hidden in graph_def. Looks for a `__lucid_metadata_json` constant string op. If present, extract it's content and convert it from json to python. If not, returns None. """ meta_matches = [n for n in graph_def.node if n.name==metadata_node_nam...
python
def extract_metadata(graph_def): """Attempt to extract meta data hidden in graph_def. Looks for a `__lucid_metadata_json` constant string op. If present, extract it's content and convert it from json to python. If not, returns None. """ meta_matches = [n for n in graph_def.node if n.name==metadata_node_nam...
[ "def", "extract_metadata", "(", "graph_def", ")", ":", "meta_matches", "=", "[", "n", "for", "n", "in", "graph_def", ".", "node", "if", "n", ".", "name", "==", "metadata_node_name", "]", "if", "meta_matches", ":", "assert", "len", "(", "meta_matches", ")",...
Attempt to extract meta data hidden in graph_def. Looks for a `__lucid_metadata_json` constant string op. If present, extract it's content and convert it from json to python. If not, returns None.
[ "Attempt", "to", "extract", "meta", "data", "hidden", "in", "graph_def", "." ]
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/modelzoo/util.py#L102-L115
train
tensorflow/lucid
lucid/modelzoo/util.py
GraphDefHelper.neighborhood
def neighborhood(self, node, degree=4): """Am I really handcoding graph traversal please no""" assert self.by_name[node.name] == node already_visited = frontier = set([node.name]) for _ in range(degree): neighbor_names = set() for node_name in frontier: outgoing = set(n.name for n in...
python
def neighborhood(self, node, degree=4): """Am I really handcoding graph traversal please no""" assert self.by_name[node.name] == node already_visited = frontier = set([node.name]) for _ in range(degree): neighbor_names = set() for node_name in frontier: outgoing = set(n.name for n in...
[ "def", "neighborhood", "(", "self", ",", "node", ",", "degree", "=", "4", ")", ":", "assert", "self", ".", "by_name", "[", "node", ".", "name", "]", "==", "node", "already_visited", "=", "frontier", "=", "set", "(", "[", "node", ".", "name", "]", "...
Am I really handcoding graph traversal please no
[ "Am", "I", "really", "handcoding", "graph", "traversal", "please", "no" ]
d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e
https://github.com/tensorflow/lucid/blob/d1a1e2e4fd4be61b89b8cba20dc425a5ae34576e/lucid/modelzoo/util.py#L135-L147
train
Rapptz/discord.py
discord/iterators.py
HistoryIterator._retrieve_messages_before_strategy
async def _retrieve_messages_before_strategy(self, retrieve): """Retrieve messages using before parameter.""" before = self.before.id if self.before else None data = await self.logs_from(self.channel.id, retrieve, before=before) if len(data): if self.limit is not None: ...
python
async def _retrieve_messages_before_strategy(self, retrieve): """Retrieve messages using before parameter.""" before = self.before.id if self.before else None data = await self.logs_from(self.channel.id, retrieve, before=before) if len(data): if self.limit is not None: ...
[ "async", "def", "_retrieve_messages_before_strategy", "(", "self", ",", "retrieve", ")", ":", "before", "=", "self", ".", "before", ".", "id", "if", "self", ".", "before", "else", "None", "data", "=", "await", "self", ".", "logs_from", "(", "self", ".", ...
Retrieve messages using before parameter.
[ "Retrieve", "messages", "using", "before", "parameter", "." ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/iterators.py#L325-L333
train
Rapptz/discord.py
discord/iterators.py
HistoryIterator._retrieve_messages_after_strategy
async def _retrieve_messages_after_strategy(self, retrieve): """Retrieve messages using after parameter.""" after = self.after.id if self.after else None data = await self.logs_from(self.channel.id, retrieve, after=after) if len(data): if self.limit is not None: ...
python
async def _retrieve_messages_after_strategy(self, retrieve): """Retrieve messages using after parameter.""" after = self.after.id if self.after else None data = await self.logs_from(self.channel.id, retrieve, after=after) if len(data): if self.limit is not None: ...
[ "async", "def", "_retrieve_messages_after_strategy", "(", "self", ",", "retrieve", ")", ":", "after", "=", "self", ".", "after", ".", "id", "if", "self", ".", "after", "else", "None", "data", "=", "await", "self", ".", "logs_from", "(", "self", ".", "cha...
Retrieve messages using after parameter.
[ "Retrieve", "messages", "using", "after", "parameter", "." ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/iterators.py#L335-L343
train
Rapptz/discord.py
discord/iterators.py
HistoryIterator._retrieve_messages_around_strategy
async def _retrieve_messages_around_strategy(self, retrieve): """Retrieve messages using around parameter.""" if self.around: around = self.around.id if self.around else None data = await self.logs_from(self.channel.id, retrieve, around=around) self.around = None ...
python
async def _retrieve_messages_around_strategy(self, retrieve): """Retrieve messages using around parameter.""" if self.around: around = self.around.id if self.around else None data = await self.logs_from(self.channel.id, retrieve, around=around) self.around = None ...
[ "async", "def", "_retrieve_messages_around_strategy", "(", "self", ",", "retrieve", ")", ":", "if", "self", ".", "around", ":", "around", "=", "self", ".", "around", ".", "id", "if", "self", ".", "around", "else", "None", "data", "=", "await", "self", "....
Retrieve messages using around parameter.
[ "Retrieve", "messages", "using", "around", "parameter", "." ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/iterators.py#L345-L352
train
Rapptz/discord.py
discord/iterators.py
GuildIterator._retrieve_guilds_before_strategy
async def _retrieve_guilds_before_strategy(self, retrieve): """Retrieve guilds using before parameter.""" before = self.before.id if self.before else None data = await self.get_guilds(retrieve, before=before) if len(data): if self.limit is not None: self.limit...
python
async def _retrieve_guilds_before_strategy(self, retrieve): """Retrieve guilds using before parameter.""" before = self.before.id if self.before else None data = await self.get_guilds(retrieve, before=before) if len(data): if self.limit is not None: self.limit...
[ "async", "def", "_retrieve_guilds_before_strategy", "(", "self", ",", "retrieve", ")", ":", "before", "=", "self", ".", "before", ".", "id", "if", "self", ".", "before", "else", "None", "data", "=", "await", "self", ".", "get_guilds", "(", "retrieve", ",",...
Retrieve guilds using before parameter.
[ "Retrieve", "guilds", "using", "before", "parameter", "." ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/iterators.py#L571-L579
train
Rapptz/discord.py
discord/iterators.py
GuildIterator._retrieve_guilds_after_strategy
async def _retrieve_guilds_after_strategy(self, retrieve): """Retrieve guilds using after parameter.""" after = self.after.id if self.after else None data = await self.get_guilds(retrieve, after=after) if len(data): if self.limit is not None: self.limit -= ret...
python
async def _retrieve_guilds_after_strategy(self, retrieve): """Retrieve guilds using after parameter.""" after = self.after.id if self.after else None data = await self.get_guilds(retrieve, after=after) if len(data): if self.limit is not None: self.limit -= ret...
[ "async", "def", "_retrieve_guilds_after_strategy", "(", "self", ",", "retrieve", ")", ":", "after", "=", "self", ".", "after", ".", "id", "if", "self", ".", "after", "else", "None", "data", "=", "await", "self", ".", "get_guilds", "(", "retrieve", ",", "...
Retrieve guilds using after parameter.
[ "Retrieve", "guilds", "using", "after", "parameter", "." ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/iterators.py#L581-L589
train
Rapptz/discord.py
discord/widget.py
Widget.fetch_invite
async def fetch_invite(self, *, with_counts=True): """|coro| Retrieves an :class:`Invite` from a invite URL or ID. This is the same as :meth:`Client.get_invite`; the invite code is abstracted away. Parameters ----------- with_counts: :class:`bool` Wh...
python
async def fetch_invite(self, *, with_counts=True): """|coro| Retrieves an :class:`Invite` from a invite URL or ID. This is the same as :meth:`Client.get_invite`; the invite code is abstracted away. Parameters ----------- with_counts: :class:`bool` Wh...
[ "async", "def", "fetch_invite", "(", "self", ",", "*", ",", "with_counts", "=", "True", ")", ":", "if", "self", ".", "_invite", ":", "invite_id", "=", "resolve_invite", "(", "self", ".", "_invite", ")", "data", "=", "await", "self", ".", "_state", ".",...
|coro| Retrieves an :class:`Invite` from a invite URL or ID. This is the same as :meth:`Client.get_invite`; the invite code is abstracted away. Parameters ----------- with_counts: :class:`bool` Whether to include count information in the invite. This fills t...
[ "|coro|" ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/widget.py#L228-L250
train
Rapptz/discord.py
discord/colour.py
Colour.from_hsv
def from_hsv(cls, h, s, v): """Constructs a :class:`Colour` from an HSV tuple.""" rgb = colorsys.hsv_to_rgb(h, s, v) return cls.from_rgb(*(int(x * 255) for x in rgb))
python
def from_hsv(cls, h, s, v): """Constructs a :class:`Colour` from an HSV tuple.""" rgb = colorsys.hsv_to_rgb(h, s, v) return cls.from_rgb(*(int(x * 255) for x in rgb))
[ "def", "from_hsv", "(", "cls", ",", "h", ",", "s", ",", "v", ")", ":", "rgb", "=", "colorsys", ".", "hsv_to_rgb", "(", "h", ",", "s", ",", "v", ")", "return", "cls", ".", "from_rgb", "(", "*", "(", "int", "(", "x", "*", "255", ")", "for", "...
Constructs a :class:`Colour` from an HSV tuple.
[ "Constructs", "a", ":", "class", ":", "Colour", "from", "an", "HSV", "tuple", "." ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/colour.py#L110-L113
train
Rapptz/discord.py
discord/ext/commands/cog.py
Cog.description
def description(self): """:class:`str`: Returns the cog's description, typically the cleaned docstring.""" try: return self.__cog_cleaned_doc__ except AttributeError: self.__cog_cleaned_doc__ = cleaned = inspect.getdoc(self) return cleaned
python
def description(self): """:class:`str`: Returns the cog's description, typically the cleaned docstring.""" try: return self.__cog_cleaned_doc__ except AttributeError: self.__cog_cleaned_doc__ = cleaned = inspect.getdoc(self) return cleaned
[ "def", "description", "(", "self", ")", ":", "try", ":", "return", "self", ".", "__cog_cleaned_doc__", "except", "AttributeError", ":", "self", ".", "__cog_cleaned_doc__", "=", "cleaned", "=", "inspect", ".", "getdoc", "(", "self", ")", "return", "cleaned" ]
:class:`str`: Returns the cog's description, typically the cleaned docstring.
[ ":", "class", ":", "str", ":", "Returns", "the", "cog", "s", "description", "typically", "the", "cleaned", "docstring", "." ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/ext/commands/cog.py#L206-L212
train
Rapptz/discord.py
discord/ext/commands/cog.py
Cog.walk_commands
def walk_commands(self): """An iterator that recursively walks through this cog's commands and subcommands.""" from .core import GroupMixin for command in self.__cog_commands__: if command.parent is None: yield command if isinstance(command, GroupMixin...
python
def walk_commands(self): """An iterator that recursively walks through this cog's commands and subcommands.""" from .core import GroupMixin for command in self.__cog_commands__: if command.parent is None: yield command if isinstance(command, GroupMixin...
[ "def", "walk_commands", "(", "self", ")", ":", "from", ".", "core", "import", "GroupMixin", "for", "command", "in", "self", ".", "__cog_commands__", ":", "if", "command", ".", "parent", "is", "None", ":", "yield", "command", "if", "isinstance", "(", "comma...
An iterator that recursively walks through this cog's commands and subcommands.
[ "An", "iterator", "that", "recursively", "walks", "through", "this", "cog", "s", "commands", "and", "subcommands", "." ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/ext/commands/cog.py#L214-L221
train
Rapptz/discord.py
discord/ext/commands/cog.py
Cog.get_listeners
def get_listeners(self): """Returns a :class:`list` of (name, function) listener pairs that are defined in this cog.""" return [(name, getattr(self, method_name)) for name, method_name in self.__cog_listeners__]
python
def get_listeners(self): """Returns a :class:`list` of (name, function) listener pairs that are defined in this cog.""" return [(name, getattr(self, method_name)) for name, method_name in self.__cog_listeners__]
[ "def", "get_listeners", "(", "self", ")", ":", "return", "[", "(", "name", ",", "getattr", "(", "self", ",", "method_name", ")", ")", "for", "name", ",", "method_name", "in", "self", ".", "__cog_listeners__", "]" ]
Returns a :class:`list` of (name, function) listener pairs that are defined in this cog.
[ "Returns", "a", ":", "class", ":", "list", "of", "(", "name", "function", ")", "listener", "pairs", "that", "are", "defined", "in", "this", "cog", "." ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/ext/commands/cog.py#L223-L225
train
Rapptz/discord.py
discord/ext/commands/cog.py
Cog.listener
def listener(cls, name=None): """A decorator that marks a function as a listener. This is the cog equivalent of :meth:`.Bot.listen`. Parameters ------------ name: :class:`str` The name of the event being listened to. If not provided, it defaults to the f...
python
def listener(cls, name=None): """A decorator that marks a function as a listener. This is the cog equivalent of :meth:`.Bot.listen`. Parameters ------------ name: :class:`str` The name of the event being listened to. If not provided, it defaults to the f...
[ "def", "listener", "(", "cls", ",", "name", "=", "None", ")", ":", "if", "name", "is", "not", "None", "and", "not", "isinstance", "(", "name", ",", "str", ")", ":", "raise", "TypeError", "(", "'Cog.listener expected str but received {0.__class__.__name__!r} inst...
A decorator that marks a function as a listener. This is the cog equivalent of :meth:`.Bot.listen`. Parameters ------------ name: :class:`str` The name of the event being listened to. If not provided, it defaults to the function's name. Raises -...
[ "A", "decorator", "that", "marks", "a", "function", "as", "a", "listener", "." ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/ext/commands/cog.py#L233-L271
train
Rapptz/discord.py
discord/embeds.py
Embed.set_footer
def set_footer(self, *, text=EmptyEmbed, icon_url=EmptyEmbed): """Sets the footer for the embed content. This function returns the class instance to allow for fluent-style chaining. Parameters ----------- text: :class:`str` The footer text. icon_url:...
python
def set_footer(self, *, text=EmptyEmbed, icon_url=EmptyEmbed): """Sets the footer for the embed content. This function returns the class instance to allow for fluent-style chaining. Parameters ----------- text: :class:`str` The footer text. icon_url:...
[ "def", "set_footer", "(", "self", ",", "*", ",", "text", "=", "EmptyEmbed", ",", "icon_url", "=", "EmptyEmbed", ")", ":", "self", ".", "_footer", "=", "{", "}", "if", "text", "is", "not", "EmptyEmbed", ":", "self", ".", "_footer", "[", "'text'", "]",...
Sets the footer for the embed content. This function returns the class instance to allow for fluent-style chaining. Parameters ----------- text: :class:`str` The footer text. icon_url: :class:`str` The URL of the footer icon. Only HTTP(S) is supp...
[ "Sets", "the", "footer", "for", "the", "embed", "content", "." ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/embeds.py#L233-L254
train
Rapptz/discord.py
discord/embeds.py
Embed.set_author
def set_author(self, *, name, url=EmptyEmbed, icon_url=EmptyEmbed): """Sets the author for the embed content. This function returns the class instance to allow for fluent-style chaining. Parameters ----------- name: :class:`str` The name of the author. ...
python
def set_author(self, *, name, url=EmptyEmbed, icon_url=EmptyEmbed): """Sets the author for the embed content. This function returns the class instance to allow for fluent-style chaining. Parameters ----------- name: :class:`str` The name of the author. ...
[ "def", "set_author", "(", "self", ",", "*", ",", "name", ",", "url", "=", "EmptyEmbed", ",", "icon_url", "=", "EmptyEmbed", ")", ":", "self", ".", "_author", "=", "{", "'name'", ":", "str", "(", "name", ")", "}", "if", "url", "is", "not", "EmptyEmb...
Sets the author for the embed content. This function returns the class instance to allow for fluent-style chaining. Parameters ----------- name: :class:`str` The name of the author. url: :class:`str` The URL for the author. icon_url: :cla...
[ "Sets", "the", "author", "for", "the", "embed", "content", "." ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/embeds.py#L356-L382
train
Rapptz/discord.py
discord/embeds.py
Embed.add_field
def add_field(self, *, name, value, inline=True): """Adds a field to the embed object. This function returns the class instance to allow for fluent-style chaining. Parameters ----------- name: :class:`str` The name of the field. value: :class:`str` ...
python
def add_field(self, *, name, value, inline=True): """Adds a field to the embed object. This function returns the class instance to allow for fluent-style chaining. Parameters ----------- name: :class:`str` The name of the field. value: :class:`str` ...
[ "def", "add_field", "(", "self", ",", "*", ",", "name", ",", "value", ",", "inline", "=", "True", ")", ":", "field", "=", "{", "'inline'", ":", "inline", ",", "'name'", ":", "str", "(", "name", ")", ",", "'value'", ":", "str", "(", "value", ")", ...
Adds a field to the embed object. This function returns the class instance to allow for fluent-style chaining. Parameters ----------- name: :class:`str` The name of the field. value: :class:`str` The value of the field. inline: :class:`bo...
[ "Adds", "a", "field", "to", "the", "embed", "object", "." ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/embeds.py#L394-L421
train
Rapptz/discord.py
discord/embeds.py
Embed.set_field_at
def set_field_at(self, index, *, name, value, inline=True): """Modifies a field to the embed object. The index must point to a valid pre-existing field. This function returns the class instance to allow for fluent-style chaining. Parameters ----------- index: :...
python
def set_field_at(self, index, *, name, value, inline=True): """Modifies a field to the embed object. The index must point to a valid pre-existing field. This function returns the class instance to allow for fluent-style chaining. Parameters ----------- index: :...
[ "def", "set_field_at", "(", "self", ",", "index", ",", "*", ",", "name", ",", "value", ",", "inline", "=", "True", ")", ":", "try", ":", "field", "=", "self", ".", "_fields", "[", "index", "]", "except", "(", "TypeError", ",", "IndexError", ",", "A...
Modifies a field to the embed object. The index must point to a valid pre-existing field. This function returns the class instance to allow for fluent-style chaining. Parameters ----------- index: :class:`int` The index of the field to modify. name:...
[ "Modifies", "a", "field", "to", "the", "embed", "object", "." ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/embeds.py#L451-L484
train
Rapptz/discord.py
discord/embeds.py
Embed.to_dict
def to_dict(self): """Converts this embed object into a dict.""" # add in the raw data into the dict result = { key[1:]: getattr(self, key) for key in self.__slots__ if key[0] == '_' and hasattr(self, key) } # deal with basic convenience wrap...
python
def to_dict(self): """Converts this embed object into a dict.""" # add in the raw data into the dict result = { key[1:]: getattr(self, key) for key in self.__slots__ if key[0] == '_' and hasattr(self, key) } # deal with basic convenience wrap...
[ "def", "to_dict", "(", "self", ")", ":", "# add in the raw data into the dict", "result", "=", "{", "key", "[", "1", ":", "]", ":", "getattr", "(", "self", ",", "key", ")", "for", "key", "in", "self", ".", "__slots__", "if", "key", "[", "0", "]", "==...
Converts this embed object into a dict.
[ "Converts", "this", "embed", "object", "into", "a", "dict", "." ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/embeds.py#L486-L530
train
Rapptz/discord.py
discord/user.py
BaseUser.avatar_url_as
def avatar_url_as(self, *, format=None, static_format='webp', size=1024): """Returns a friendly URL version of the avatar the user has. If the user does not have a traditional avatar, their default avatar URL is returned instead. The format must be one of 'webp', 'jpeg', 'jpg', 'png' o...
python
def avatar_url_as(self, *, format=None, static_format='webp', size=1024): """Returns a friendly URL version of the avatar the user has. If the user does not have a traditional avatar, their default avatar URL is returned instead. The format must be one of 'webp', 'jpeg', 'jpg', 'png' o...
[ "def", "avatar_url_as", "(", "self", ",", "*", ",", "format", "=", "None", ",", "static_format", "=", "'webp'", ",", "size", "=", "1024", ")", ":", "return", "Asset", ".", "_from_avatar", "(", "self", ".", "_state", ",", "self", ",", "format", "=", "...
Returns a friendly URL version of the avatar the user has. If the user does not have a traditional avatar, their default avatar URL is returned instead. The format must be one of 'webp', 'jpeg', 'jpg', 'png' or 'gif', and 'gif' is only valid for animated avatars. The size must be a pow...
[ "Returns", "a", "friendly", "URL", "version", "of", "the", "avatar", "the", "user", "has", "." ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/user.py#L131-L165
train
Rapptz/discord.py
discord/user.py
BaseUser.mentioned_in
def mentioned_in(self, message): """Checks if the user is mentioned in the specified message. Parameters ----------- message: :class:`Message` The message to check if you're mentioned in. """ if message.mention_everyone: return True for ...
python
def mentioned_in(self, message): """Checks if the user is mentioned in the specified message. Parameters ----------- message: :class:`Message` The message to check if you're mentioned in. """ if message.mention_everyone: return True for ...
[ "def", "mentioned_in", "(", "self", ",", "message", ")", ":", "if", "message", ".", "mention_everyone", ":", "return", "True", "for", "user", "in", "message", ".", "mentions", ":", "if", "user", ".", "id", "==", "self", ".", "id", ":", "return", "True"...
Checks if the user is mentioned in the specified message. Parameters ----------- message: :class:`Message` The message to check if you're mentioned in.
[ "Checks", "if", "the", "user", "is", "mentioned", "in", "the", "specified", "message", "." ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/user.py#L226-L242
train
Rapptz/discord.py
discord/user.py
ClientUser.friends
def friends(self): r"""Returns a :class:`list` of :class:`User`\s that the user is friends with. .. note:: This only applies to non-bot accounts. """ return [r.user for r in self._relationships.values() if r.type is RelationshipType.friend]
python
def friends(self): r"""Returns a :class:`list` of :class:`User`\s that the user is friends with. .. note:: This only applies to non-bot accounts. """ return [r.user for r in self._relationships.values() if r.type is RelationshipType.friend]
[ "def", "friends", "(", "self", ")", ":", "return", "[", "r", ".", "user", "for", "r", "in", "self", ".", "_relationships", ".", "values", "(", ")", "if", "r", ".", "type", "is", "RelationshipType", ".", "friend", "]" ]
r"""Returns a :class:`list` of :class:`User`\s that the user is friends with. .. note:: This only applies to non-bot accounts.
[ "r", "Returns", "a", ":", "class", ":", "list", "of", ":", "class", ":", "User", "\\", "s", "that", "the", "user", "is", "friends", "with", "." ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/user.py#L342-L349
train
Rapptz/discord.py
discord/user.py
ClientUser.blocked
def blocked(self): r"""Returns a :class:`list` of :class:`User`\s that the user has blocked. .. note:: This only applies to non-bot accounts. """ return [r.user for r in self._relationships.values() if r.type is RelationshipType.blocked]
python
def blocked(self): r"""Returns a :class:`list` of :class:`User`\s that the user has blocked. .. note:: This only applies to non-bot accounts. """ return [r.user for r in self._relationships.values() if r.type is RelationshipType.blocked]
[ "def", "blocked", "(", "self", ")", ":", "return", "[", "r", ".", "user", "for", "r", "in", "self", ".", "_relationships", ".", "values", "(", ")", "if", "r", ".", "type", "is", "RelationshipType", ".", "blocked", "]" ]
r"""Returns a :class:`list` of :class:`User`\s that the user has blocked. .. note:: This only applies to non-bot accounts.
[ "r", "Returns", "a", ":", "class", ":", "list", "of", ":", "class", ":", "User", "\\", "s", "that", "the", "user", "has", "blocked", "." ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/user.py#L352-L359
train
Rapptz/discord.py
discord/user.py
ClientUser.edit
async def edit(self, **fields): """|coro| Edits the current profile of the client. If a bot account is used then a password field is optional, otherwise it is required. Note ----- To upload an avatar, a :term:`py:bytes-like object` must be passed in that ...
python
async def edit(self, **fields): """|coro| Edits the current profile of the client. If a bot account is used then a password field is optional, otherwise it is required. Note ----- To upload an avatar, a :term:`py:bytes-like object` must be passed in that ...
[ "async", "def", "edit", "(", "self", ",", "*", "*", "fields", ")", ":", "try", ":", "avatar_bytes", "=", "fields", "[", "'avatar'", "]", "except", "KeyError", ":", "avatar", "=", "self", ".", "avatar", "else", ":", "if", "avatar_bytes", "is", "not", ...
|coro| Edits the current profile of the client. If a bot account is used then a password field is optional, otherwise it is required. Note ----- To upload an avatar, a :term:`py:bytes-like object` must be passed in that represents the image being uploaded. If t...
[ "|coro|" ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/user.py#L361-L458
train
Rapptz/discord.py
discord/user.py
ClientUser.create_group
async def create_group(self, *recipients): r"""|coro| Creates a group direct message with the recipients provided. These recipients must be have a relationship of type :attr:`RelationshipType.friend`. .. note:: This only applies to non-bot accounts. Parame...
python
async def create_group(self, *recipients): r"""|coro| Creates a group direct message with the recipients provided. These recipients must be have a relationship of type :attr:`RelationshipType.friend`. .. note:: This only applies to non-bot accounts. Parame...
[ "async", "def", "create_group", "(", "self", ",", "*", "recipients", ")", ":", "from", ".", "channel", "import", "GroupChannel", "if", "len", "(", "recipients", ")", "<", "2", ":", "raise", "ClientException", "(", "'You must have two or more recipients to create a...
r"""|coro| Creates a group direct message with the recipients provided. These recipients must be have a relationship of type :attr:`RelationshipType.friend`. .. note:: This only applies to non-bot accounts. Parameters ----------- \*recipients: :cla...
[ "r", "|coro|" ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/user.py#L460-L498
train
Rapptz/discord.py
discord/user.py
ClientUser.edit_settings
async def edit_settings(self, **kwargs): """|coro| Edits the client user's settings. .. note:: This only applies to non-bot accounts. Parameters ------- afk_timeout: :class:`int` How long (in seconds) the user needs to be AFK until Discord ...
python
async def edit_settings(self, **kwargs): """|coro| Edits the client user's settings. .. note:: This only applies to non-bot accounts. Parameters ------- afk_timeout: :class:`int` How long (in seconds) the user needs to be AFK until Discord ...
[ "async", "def", "edit_settings", "(", "self", ",", "*", "*", "kwargs", ")", ":", "payload", "=", "{", "}", "content_filter", "=", "kwargs", ".", "pop", "(", "'explicit_content_filter'", ",", "None", ")", "if", "content_filter", ":", "payload", ".", "update...
|coro| Edits the client user's settings. .. note:: This only applies to non-bot accounts. Parameters ------- afk_timeout: :class:`int` How long (in seconds) the user needs to be AFK until Discord sends push notifications to your mobile devi...
[ "|coro|" ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/user.py#L500-L609
train
Rapptz/discord.py
discord/user.py
User.create_dm
async def create_dm(self): """Creates a :class:`DMChannel` with this user. This should be rarely called, as this is done transparently for most people. """ found = self.dm_channel if found is not None: return found state = self._state data = ...
python
async def create_dm(self): """Creates a :class:`DMChannel` with this user. This should be rarely called, as this is done transparently for most people. """ found = self.dm_channel if found is not None: return found state = self._state data = ...
[ "async", "def", "create_dm", "(", "self", ")", ":", "found", "=", "self", ".", "dm_channel", "if", "found", "is", "not", "None", ":", "return", "found", "state", "=", "self", ".", "_state", "data", "=", "await", "state", ".", "http", ".", "start_privat...
Creates a :class:`DMChannel` with this user. This should be rarely called, as this is done transparently for most people.
[ "Creates", "a", ":", "class", ":", "DMChannel", "with", "this", "user", "." ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/user.py#L664-L676
train
Rapptz/discord.py
discord/user.py
User.mutual_friends
async def mutual_friends(self): """|coro| Gets all mutual friends of this user. .. note:: This only applies to non-bot accounts. Raises ------- Forbidden Not allowed to get mutual friends of this user. HTTPException Getting ...
python
async def mutual_friends(self): """|coro| Gets all mutual friends of this user. .. note:: This only applies to non-bot accounts. Raises ------- Forbidden Not allowed to get mutual friends of this user. HTTPException Getting ...
[ "async", "def", "mutual_friends", "(", "self", ")", ":", "state", "=", "self", ".", "_state", "mutuals", "=", "await", "state", ".", "http", ".", "get_mutual_friends", "(", "self", ".", "id", ")", "return", "[", "User", "(", "state", "=", "state", ",",...
|coro| Gets all mutual friends of this user. .. note:: This only applies to non-bot accounts. Raises ------- Forbidden Not allowed to get mutual friends of this user. HTTPException Getting mutual friends failed. Returns ...
[ "|coro|" ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/user.py#L688-L711
train
Rapptz/discord.py
discord/user.py
User.is_friend
def is_friend(self): """:class:`bool`: Checks if the user is your friend. .. note:: This only applies to non-bot accounts. """ r = self.relationship if r is None: return False return r.type is RelationshipType.friend
python
def is_friend(self): """:class:`bool`: Checks if the user is your friend. .. note:: This only applies to non-bot accounts. """ r = self.relationship if r is None: return False return r.type is RelationshipType.friend
[ "def", "is_friend", "(", "self", ")", ":", "r", "=", "self", ".", "relationship", "if", "r", "is", "None", ":", "return", "False", "return", "r", ".", "type", "is", "RelationshipType", ".", "friend" ]
:class:`bool`: Checks if the user is your friend. .. note:: This only applies to non-bot accounts.
[ ":", "class", ":", "bool", ":", "Checks", "if", "the", "user", "is", "your", "friend", "." ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/user.py#L713-L723
train
Rapptz/discord.py
discord/user.py
User.is_blocked
def is_blocked(self): """:class:`bool`: Checks if the user is blocked. .. note:: This only applies to non-bot accounts. """ r = self.relationship if r is None: return False return r.type is RelationshipType.blocked
python
def is_blocked(self): """:class:`bool`: Checks if the user is blocked. .. note:: This only applies to non-bot accounts. """ r = self.relationship if r is None: return False return r.type is RelationshipType.blocked
[ "def", "is_blocked", "(", "self", ")", ":", "r", "=", "self", ".", "relationship", "if", "r", "is", "None", ":", "return", "False", "return", "r", ".", "type", "is", "RelationshipType", ".", "blocked" ]
:class:`bool`: Checks if the user is blocked. .. note:: This only applies to non-bot accounts.
[ ":", "class", ":", "bool", ":", "Checks", "if", "the", "user", "is", "blocked", "." ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/user.py#L725-L735
train
Rapptz/discord.py
discord/user.py
User.block
async def block(self): """|coro| Blocks the user. .. note:: This only applies to non-bot accounts. Raises ------- Forbidden Not allowed to block this user. HTTPException Blocking the user failed. """ await s...
python
async def block(self): """|coro| Blocks the user. .. note:: This only applies to non-bot accounts. Raises ------- Forbidden Not allowed to block this user. HTTPException Blocking the user failed. """ await s...
[ "async", "def", "block", "(", "self", ")", ":", "await", "self", ".", "_state", ".", "http", ".", "add_relationship", "(", "self", ".", "id", ",", "type", "=", "RelationshipType", ".", "blocked", ".", "value", ")" ]
|coro| Blocks the user. .. note:: This only applies to non-bot accounts. Raises ------- Forbidden Not allowed to block this user. HTTPException Blocking the user failed.
[ "|coro|" ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/user.py#L737-L754
train
Rapptz/discord.py
discord/user.py
User.send_friend_request
async def send_friend_request(self): """|coro| Sends the user a friend request. .. note:: This only applies to non-bot accounts. Raises ------- Forbidden Not allowed to send a friend request to the user. HTTPException Sendin...
python
async def send_friend_request(self): """|coro| Sends the user a friend request. .. note:: This only applies to non-bot accounts. Raises ------- Forbidden Not allowed to send a friend request to the user. HTTPException Sendin...
[ "async", "def", "send_friend_request", "(", "self", ")", ":", "await", "self", ".", "_state", ".", "http", ".", "send_friend_request", "(", "username", "=", "self", ".", "name", ",", "discriminator", "=", "self", ".", "discriminator", ")" ]
|coro| Sends the user a friend request. .. note:: This only applies to non-bot accounts. Raises ------- Forbidden Not allowed to send a friend request to the user. HTTPException Sending the friend request failed.
[ "|coro|" ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/user.py#L792-L808
train
Rapptz/discord.py
discord/user.py
User.profile
async def profile(self): """|coro| Gets the user's profile. .. note:: This only applies to non-bot accounts. Raises ------- Forbidden Not allowed to fetch profiles. HTTPException Fetching the profile failed. Returns...
python
async def profile(self): """|coro| Gets the user's profile. .. note:: This only applies to non-bot accounts. Raises ------- Forbidden Not allowed to fetch profiles. HTTPException Fetching the profile failed. Returns...
[ "async", "def", "profile", "(", "self", ")", ":", "state", "=", "self", ".", "_state", "data", "=", "await", "state", ".", "http", ".", "get_user_profile", "(", "self", ".", "id", ")", "def", "transform", "(", "d", ")", ":", "return", "state", ".", ...
|coro| Gets the user's profile. .. note:: This only applies to non-bot accounts. Raises ------- Forbidden Not allowed to fetch profiles. HTTPException Fetching the profile failed. Returns -------- :class:`Pr...
[ "|coro|" ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/user.py#L810-L844
train
Rapptz/discord.py
discord/utils.py
time_snowflake
def time_snowflake(datetime_obj, high=False): """Returns a numeric snowflake pretending to be created at the given date. When using as the lower end of a range, use time_snowflake(high=False) - 1 to be inclusive, high=True to be exclusive When using as the higher end of a range, use time_snowflake(high=Tru...
python
def time_snowflake(datetime_obj, high=False): """Returns a numeric snowflake pretending to be created at the given date. When using as the lower end of a range, use time_snowflake(high=False) - 1 to be inclusive, high=True to be exclusive When using as the higher end of a range, use time_snowflake(high=Tru...
[ "def", "time_snowflake", "(", "datetime_obj", ",", "high", "=", "False", ")", ":", "unix_seconds", "=", "(", "datetime_obj", "-", "type", "(", "datetime_obj", ")", "(", "1970", ",", "1", ",", "1", ")", ")", ".", "total_seconds", "(", ")", "discord_millis...
Returns a numeric snowflake pretending to be created at the given date. When using as the lower end of a range, use time_snowflake(high=False) - 1 to be inclusive, high=True to be exclusive When using as the higher end of a range, use time_snowflake(high=True) + 1 to be inclusive, high=False to be exclusive ...
[ "Returns", "a", "numeric", "snowflake", "pretending", "to", "be", "created", "at", "the", "given", "date", "." ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/utils.py#L160-L176
train
Rapptz/discord.py
discord/utils.py
get
def get(iterable, **attrs): r"""A helper that returns the first element in the iterable that meets all the traits passed in ``attrs``. This is an alternative for :func:`discord.utils.find`. When multiple attributes are specified, they are checked using logical AND, not logical OR. Meaning they have...
python
def get(iterable, **attrs): r"""A helper that returns the first element in the iterable that meets all the traits passed in ``attrs``. This is an alternative for :func:`discord.utils.find`. When multiple attributes are specified, they are checked using logical AND, not logical OR. Meaning they have...
[ "def", "get", "(", "iterable", ",", "*", "*", "attrs", ")", ":", "def", "predicate", "(", "elem", ")", ":", "for", "attr", ",", "val", "in", "attrs", ".", "items", "(", ")", ":", "nested", "=", "attr", ".", "split", "(", "'__'", ")", "obj", "="...
r"""A helper that returns the first element in the iterable that meets all the traits passed in ``attrs``. This is an alternative for :func:`discord.utils.find`. When multiple attributes are specified, they are checked using logical AND, not logical OR. Meaning they have to meet every attribute pas...
[ "r", "A", "helper", "that", "returns", "the", "first", "element", "in", "the", "iterable", "that", "meets", "all", "the", "traits", "passed", "in", "attrs", ".", "This", "is", "an", "alternative", "for", ":", "func", ":", "discord", ".", "utils", ".", ...
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/utils.py#L206-L261
train
Rapptz/discord.py
discord/utils.py
_string_width
def _string_width(string, *, _IS_ASCII=_IS_ASCII): """Returns string's width.""" match = _IS_ASCII.match(string) if match: return match.endpos UNICODE_WIDE_CHAR_TYPE = 'WFA' width = 0 func = unicodedata.east_asian_width for char in string: width += 2 if func(char) in UNICODE...
python
def _string_width(string, *, _IS_ASCII=_IS_ASCII): """Returns string's width.""" match = _IS_ASCII.match(string) if match: return match.endpos UNICODE_WIDE_CHAR_TYPE = 'WFA' width = 0 func = unicodedata.east_asian_width for char in string: width += 2 if func(char) in UNICODE...
[ "def", "_string_width", "(", "string", ",", "*", ",", "_IS_ASCII", "=", "_IS_ASCII", ")", ":", "match", "=", "_IS_ASCII", ".", "match", "(", "string", ")", "if", "match", ":", "return", "match", ".", "endpos", "UNICODE_WIDE_CHAR_TYPE", "=", "'WFA'", "width...
Returns string's width.
[ "Returns", "string", "s", "width", "." ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/utils.py#L359-L370
train
Rapptz/discord.py
discord/utils.py
resolve_invite
def resolve_invite(invite): """ Resolves an invite from a :class:`Invite`, URL or ID Parameters ----------- invite: Union[:class:`Invite`, :class:`Object`, :class:`str`] The invite. Returns -------- :class:`str` The invite code. """ from .invite import Invite #...
python
def resolve_invite(invite): """ Resolves an invite from a :class:`Invite`, URL or ID Parameters ----------- invite: Union[:class:`Invite`, :class:`Object`, :class:`str`] The invite. Returns -------- :class:`str` The invite code. """ from .invite import Invite #...
[ "def", "resolve_invite", "(", "invite", ")", ":", "from", ".", "invite", "import", "Invite", "# circular import", "if", "isinstance", "(", "invite", ",", "Invite", ")", "or", "isinstance", "(", "invite", ",", "Object", ")", ":", "return", "invite", ".", "i...
Resolves an invite from a :class:`Invite`, URL or ID Parameters ----------- invite: Union[:class:`Invite`, :class:`Object`, :class:`str`] The invite. Returns -------- :class:`str` The invite code.
[ "Resolves", "an", "invite", "from", "a", ":", "class", ":", "Invite", "URL", "or", "ID" ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/utils.py#L372-L394
train
Rapptz/discord.py
discord/utils.py
escape_markdown
def escape_markdown(text, *, as_needed=False, ignore_links=True): r"""A helper function that escapes Discord's markdown. Parameters ----------- text: :class:`str` The text to escape markdown from. as_needed: :class:`bool` Whether to escape the markdown characters as needed. This ...
python
def escape_markdown(text, *, as_needed=False, ignore_links=True): r"""A helper function that escapes Discord's markdown. Parameters ----------- text: :class:`str` The text to escape markdown from. as_needed: :class:`bool` Whether to escape the markdown characters as needed. This ...
[ "def", "escape_markdown", "(", "text", ",", "*", ",", "as_needed", "=", "False", ",", "ignore_links", "=", "True", ")", ":", "if", "not", "as_needed", ":", "url_regex", "=", "r'(?P<url>(?:https?|steam)://(?:-\\.)?(?:[^\\s/?\\.#-]+\\.?)+(?:/[^\\s]*)?)'", "def", "replac...
r"""A helper function that escapes Discord's markdown. Parameters ----------- text: :class:`str` The text to escape markdown from. as_needed: :class:`bool` Whether to escape the markdown characters as needed. This means that it does not escape extraneous characters if it's ...
[ "r", "A", "helper", "function", "that", "escapes", "Discord", "s", "markdown", "." ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/utils.py#L401-L441
train
Rapptz/discord.py
examples/basic_bot.py
add
async def add(ctx, left: int, right: int): """Adds two numbers together.""" await ctx.send(left + right)
python
async def add(ctx, left: int, right: int): """Adds two numbers together.""" await ctx.send(left + right)
[ "async", "def", "add", "(", "ctx", ",", "left", ":", "int", ",", "right", ":", "int", ")", ":", "await", "ctx", ".", "send", "(", "left", "+", "right", ")" ]
Adds two numbers together.
[ "Adds", "two", "numbers", "together", "." ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/examples/basic_bot.py#L19-L21
train
Rapptz/discord.py
examples/basic_bot.py
roll
async def roll(ctx, dice: str): """Rolls a dice in NdN format.""" try: rolls, limit = map(int, dice.split('d')) except Exception: await ctx.send('Format has to be in NdN!') return result = ', '.join(str(random.randint(1, limit)) for r in range(rolls)) await ctx.send(result)
python
async def roll(ctx, dice: str): """Rolls a dice in NdN format.""" try: rolls, limit = map(int, dice.split('d')) except Exception: await ctx.send('Format has to be in NdN!') return result = ', '.join(str(random.randint(1, limit)) for r in range(rolls)) await ctx.send(result)
[ "async", "def", "roll", "(", "ctx", ",", "dice", ":", "str", ")", ":", "try", ":", "rolls", ",", "limit", "=", "map", "(", "int", ",", "dice", ".", "split", "(", "'d'", ")", ")", "except", "Exception", ":", "await", "ctx", ".", "send", "(", "'F...
Rolls a dice in NdN format.
[ "Rolls", "a", "dice", "in", "NdN", "format", "." ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/examples/basic_bot.py#L24-L33
train
Rapptz/discord.py
examples/basic_bot.py
repeat
async def repeat(ctx, times: int, content='repeating...'): """Repeats a message multiple times.""" for i in range(times): await ctx.send(content)
python
async def repeat(ctx, times: int, content='repeating...'): """Repeats a message multiple times.""" for i in range(times): await ctx.send(content)
[ "async", "def", "repeat", "(", "ctx", ",", "times", ":", "int", ",", "content", "=", "'repeating...'", ")", ":", "for", "i", "in", "range", "(", "times", ")", ":", "await", "ctx", ".", "send", "(", "content", ")" ]
Repeats a message multiple times.
[ "Repeats", "a", "message", "multiple", "times", "." ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/examples/basic_bot.py#L41-L44
train
Rapptz/discord.py
examples/basic_voice.py
Music.join
async def join(self, ctx, *, channel: discord.VoiceChannel): """Joins a voice channel""" if ctx.voice_client is not None: return await ctx.voice_client.move_to(channel) await channel.connect()
python
async def join(self, ctx, *, channel: discord.VoiceChannel): """Joins a voice channel""" if ctx.voice_client is not None: return await ctx.voice_client.move_to(channel) await channel.connect()
[ "async", "def", "join", "(", "self", ",", "ctx", ",", "*", ",", "channel", ":", "discord", ".", "VoiceChannel", ")", ":", "if", "ctx", ".", "voice_client", "is", "not", "None", ":", "return", "await", "ctx", ".", "voice_client", ".", "move_to", "(", ...
Joins a voice channel
[ "Joins", "a", "voice", "channel" ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/examples/basic_voice.py#L60-L66
train
Rapptz/discord.py
examples/basic_voice.py
Music.play
async def play(self, ctx, *, query): """Plays a file from the local filesystem""" source = discord.PCMVolumeTransformer(discord.FFmpegPCMAudio(query)) ctx.voice_client.play(source, after=lambda e: print('Player error: %s' % e) if e else None) await ctx.send('Now playing: {}'.format(que...
python
async def play(self, ctx, *, query): """Plays a file from the local filesystem""" source = discord.PCMVolumeTransformer(discord.FFmpegPCMAudio(query)) ctx.voice_client.play(source, after=lambda e: print('Player error: %s' % e) if e else None) await ctx.send('Now playing: {}'.format(que...
[ "async", "def", "play", "(", "self", ",", "ctx", ",", "*", ",", "query", ")", ":", "source", "=", "discord", ".", "PCMVolumeTransformer", "(", "discord", ".", "FFmpegPCMAudio", "(", "query", ")", ")", "ctx", ".", "voice_client", ".", "play", "(", "sour...
Plays a file from the local filesystem
[ "Plays", "a", "file", "from", "the", "local", "filesystem" ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/examples/basic_voice.py#L69-L75
train
Rapptz/discord.py
examples/basic_voice.py
Music.stream
async def stream(self, ctx, *, url): """Streams from a url (same as yt, but doesn't predownload)""" async with ctx.typing(): player = await YTDLSource.from_url(url, loop=self.bot.loop, stream=True) ctx.voice_client.play(player, after=lambda e: print('Player error: %s' % e) if e ...
python
async def stream(self, ctx, *, url): """Streams from a url (same as yt, but doesn't predownload)""" async with ctx.typing(): player = await YTDLSource.from_url(url, loop=self.bot.loop, stream=True) ctx.voice_client.play(player, after=lambda e: print('Player error: %s' % e) if e ...
[ "async", "def", "stream", "(", "self", ",", "ctx", ",", "*", ",", "url", ")", ":", "async", "with", "ctx", ".", "typing", "(", ")", ":", "player", "=", "await", "YTDLSource", ".", "from_url", "(", "url", ",", "loop", "=", "self", ".", "bot", ".",...
Streams from a url (same as yt, but doesn't predownload)
[ "Streams", "from", "a", "url", "(", "same", "as", "yt", "but", "doesn", "t", "predownload", ")" ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/examples/basic_voice.py#L88-L95
train
Rapptz/discord.py
examples/basic_voice.py
Music.volume
async def volume(self, ctx, volume: int): """Changes the player's volume""" if ctx.voice_client is None: return await ctx.send("Not connected to a voice channel.") ctx.voice_client.source.volume = volume / 100 await ctx.send("Changed volume to {}%".format(volume))
python
async def volume(self, ctx, volume: int): """Changes the player's volume""" if ctx.voice_client is None: return await ctx.send("Not connected to a voice channel.") ctx.voice_client.source.volume = volume / 100 await ctx.send("Changed volume to {}%".format(volume))
[ "async", "def", "volume", "(", "self", ",", "ctx", ",", "volume", ":", "int", ")", ":", "if", "ctx", ".", "voice_client", "is", "None", ":", "return", "await", "ctx", ".", "send", "(", "\"Not connected to a voice channel.\"", ")", "ctx", ".", "voice_client...
Changes the player's volume
[ "Changes", "the", "player", "s", "volume" ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/examples/basic_voice.py#L98-L105
train
Rapptz/discord.py
discord/calls.py
CallMessage.duration
def duration(self): """Queries the duration of the call. If the call has not ended then the current duration will be returned. Returns --------- datetime.timedelta The timedelta object representing the duration. """ if self.ended_timestamp is...
python
def duration(self): """Queries the duration of the call. If the call has not ended then the current duration will be returned. Returns --------- datetime.timedelta The timedelta object representing the duration. """ if self.ended_timestamp is...
[ "def", "duration", "(", "self", ")", ":", "if", "self", ".", "ended_timestamp", "is", "None", ":", "return", "datetime", ".", "datetime", ".", "utcnow", "(", ")", "-", "self", ".", "message", ".", "created_at", "else", ":", "return", "self", ".", "ende...
Queries the duration of the call. If the call has not ended then the current duration will be returned. Returns --------- datetime.timedelta The timedelta object representing the duration.
[ "Queries", "the", "duration", "of", "the", "call", "." ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/calls.py#L65-L79
train
Rapptz/discord.py
discord/calls.py
GroupCall.connected
def connected(self): """A property that returns the :class:`list` of :class:`User` that are currently in this call.""" ret = [u for u in self.channel.recipients if self.voice_state_for(u) is not None] me = self.channel.me if self.voice_state_for(me) is not None: ret.append(me...
python
def connected(self): """A property that returns the :class:`list` of :class:`User` that are currently in this call.""" ret = [u for u in self.channel.recipients if self.voice_state_for(u) is not None] me = self.channel.me if self.voice_state_for(me) is not None: ret.append(me...
[ "def", "connected", "(", "self", ")", ":", "ret", "=", "[", "u", "for", "u", "in", "self", ".", "channel", ".", "recipients", "if", "self", ".", "voice_state_for", "(", "u", ")", "is", "not", "None", "]", "me", "=", "self", ".", "channel", ".", "...
A property that returns the :class:`list` of :class:`User` that are currently in this call.
[ "A", "property", "that", "returns", "the", ":", "class", ":", "list", "of", ":", "class", ":", "User", "that", "are", "currently", "in", "this", "call", "." ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/calls.py#L124-L131
train
Rapptz/discord.py
discord/webhook.py
Webhook.partial
def partial(cls, id, token, *, adapter): """Creates a partial :class:`Webhook`. A partial webhook is just a webhook object with an ID and a token. Parameters ----------- id: :class:`int` The ID of the webhook. token: :class:`str` The authenticati...
python
def partial(cls, id, token, *, adapter): """Creates a partial :class:`Webhook`. A partial webhook is just a webhook object with an ID and a token. Parameters ----------- id: :class:`int` The ID of the webhook. token: :class:`str` The authenticati...
[ "def", "partial", "(", "cls", ",", "id", ",", "token", ",", "*", ",", "adapter", ")", ":", "if", "not", "isinstance", "(", "adapter", ",", "WebhookAdapter", ")", ":", "raise", "TypeError", "(", "'adapter must be a subclass of WebhookAdapter'", ")", "data", "...
Creates a partial :class:`Webhook`. A partial webhook is just a webhook object with an ID and a token. Parameters ----------- id: :class:`int` The ID of the webhook. token: :class:`str` The authentication token of the webhook. adapter: :class:`We...
[ "Creates", "a", "partial", ":", "class", ":", "Webhook", "." ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/webhook.py#L446-L471
train
Rapptz/discord.py
discord/webhook.py
Webhook.from_url
def from_url(cls, url, *, adapter): """Creates a partial :class:`Webhook` from a webhook URL. Parameters ------------ url: :class:`str` The URL of the webhook. adapter: :class:`WebhookAdapter` The webhook adapter to use when sending requests. This is ...
python
def from_url(cls, url, *, adapter): """Creates a partial :class:`Webhook` from a webhook URL. Parameters ------------ url: :class:`str` The URL of the webhook. adapter: :class:`WebhookAdapter` The webhook adapter to use when sending requests. This is ...
[ "def", "from_url", "(", "cls", ",", "url", ",", "*", ",", "adapter", ")", ":", "m", "=", "re", ".", "search", "(", "r'discordapp.com/api/webhooks/(?P<id>[0-9]{17,21})/(?P<token>[A-Za-z0-9\\.\\-\\_]{60,68})'", ",", "url", ")", "if", "m", "is", "None", ":", "raise...
Creates a partial :class:`Webhook` from a webhook URL. Parameters ------------ url: :class:`str` The URL of the webhook. adapter: :class:`WebhookAdapter` The webhook adapter to use when sending requests. This is typically :class:`AsyncWebhookAdapter` ...
[ "Creates", "a", "partial", ":", "class", ":", "Webhook", "from", "a", "webhook", "URL", "." ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/webhook.py#L474-L495
train
Rapptz/discord.py
discord/webhook.py
Webhook.channel
def channel(self): """Optional[:class:`TextChannel`]: The text channel this webhook belongs to. If this is a partial webhook, then this will always return ``None``. """ guild = self.guild return guild and guild.get_channel(self.channel_id)
python
def channel(self): """Optional[:class:`TextChannel`]: The text channel this webhook belongs to. If this is a partial webhook, then this will always return ``None``. """ guild = self.guild return guild and guild.get_channel(self.channel_id)
[ "def", "channel", "(", "self", ")", ":", "guild", "=", "self", ".", "guild", "return", "guild", "and", "guild", ".", "get_channel", "(", "self", ".", "channel_id", ")" ]
Optional[:class:`TextChannel`]: The text channel this webhook belongs to. If this is a partial webhook, then this will always return ``None``.
[ "Optional", "[", ":", "class", ":", "TextChannel", "]", ":", "The", "text", "channel", "this", "webhook", "belongs", "to", "." ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/webhook.py#L511-L517
train
Rapptz/discord.py
discord/webhook.py
Webhook.avatar_url_as
def avatar_url_as(self, *, format=None, size=1024): """Returns a friendly URL version of the avatar the webhook has. If the webhook does not have a traditional avatar, their default avatar URL is returned instead. The format must be one of 'jpeg', 'jpg', or 'png'. The size must...
python
def avatar_url_as(self, *, format=None, size=1024): """Returns a friendly URL version of the avatar the webhook has. If the webhook does not have a traditional avatar, their default avatar URL is returned instead. The format must be one of 'jpeg', 'jpg', or 'png'. The size must...
[ "def", "avatar_url_as", "(", "self", ",", "*", ",", "format", "=", "None", ",", "size", "=", "1024", ")", ":", "if", "self", ".", "avatar", "is", "None", ":", "# Default is always blurple apparently", "return", "Asset", "(", "self", ".", "_state", ",", "...
Returns a friendly URL version of the avatar the webhook has. If the webhook does not have a traditional avatar, their default avatar URL is returned instead. The format must be one of 'jpeg', 'jpg', or 'png'. The size must be a power of 2 between 16 and 1024. Parameters ...
[ "Returns", "a", "friendly", "URL", "version", "of", "the", "avatar", "the", "webhook", "has", "." ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/webhook.py#L536-L576
train
Rapptz/discord.py
discord/webhook.py
Webhook.edit
def edit(self, **kwargs): """|maybecoro| Edits this Webhook. If the webhook is constructed with a :class:`RequestsWebhookAdapter` then this is not a coroutine. Parameters ------------- name: Optional[:class:`str`] The webhook's new default name. ...
python
def edit(self, **kwargs): """|maybecoro| Edits this Webhook. If the webhook is constructed with a :class:`RequestsWebhookAdapter` then this is not a coroutine. Parameters ------------- name: Optional[:class:`str`] The webhook's new default name. ...
[ "def", "edit", "(", "self", ",", "*", "*", "kwargs", ")", ":", "payload", "=", "{", "}", "try", ":", "name", "=", "kwargs", "[", "'name'", "]", "except", "KeyError", ":", "pass", "else", ":", "if", "name", "is", "not", "None", ":", "payload", "["...
|maybecoro| Edits this Webhook. If the webhook is constructed with a :class:`RequestsWebhookAdapter` then this is not a coroutine. Parameters ------------- name: Optional[:class:`str`] The webhook's new default name. avatar: Optional[:class:`bytes`]...
[ "|maybecoro|" ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/webhook.py#L597-L643
train
Rapptz/discord.py
discord/webhook.py
Webhook.send
def send(self, content=None, *, wait=False, username=None, avatar_url=None, tts=False, file=None, files=None, embed=None, embeds=None): """|maybecoro| Sends a message using the webhook. If the webhook is constructed with a :class:`RequestsWebhookAdapter` the...
python
def send(self, content=None, *, wait=False, username=None, avatar_url=None, tts=False, file=None, files=None, embed=None, embeds=None): """|maybecoro| Sends a message using the webhook. If the webhook is constructed with a :class:`RequestsWebhookAdapter` the...
[ "def", "send", "(", "self", ",", "content", "=", "None", ",", "*", ",", "wait", "=", "False", ",", "username", "=", "None", ",", "avatar_url", "=", "None", ",", "tts", "=", "False", ",", "file", "=", "None", ",", "files", "=", "None", ",", "embed...
|maybecoro| Sends a message using the webhook. If the webhook is constructed with a :class:`RequestsWebhookAdapter` then this is not a coroutine. The content must be a type that can convert to a string through ``str(content)``. To upload a single file, the ``file`` parameter ...
[ "|maybecoro|" ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/webhook.py#L645-L733
train
Rapptz/discord.py
discord/reaction.py
Reaction.users
def users(self, limit=None, after=None): """Returns an :class:`AsyncIterator` representing the users that have reacted to the message. The ``after`` parameter must represent a member and meet the :class:`abc.Snowflake` abc. Examples --------- Usage :: # I ...
python
def users(self, limit=None, after=None): """Returns an :class:`AsyncIterator` representing the users that have reacted to the message. The ``after`` parameter must represent a member and meet the :class:`abc.Snowflake` abc. Examples --------- Usage :: # I ...
[ "def", "users", "(", "self", ",", "limit", "=", "None", ",", "after", "=", "None", ")", ":", "if", "self", ".", "custom_emoji", ":", "emoji", "=", "'{0.name}:{0.id}'", ".", "format", "(", "self", ".", "emoji", ")", "else", ":", "emoji", "=", "self", ...
Returns an :class:`AsyncIterator` representing the users that have reacted to the message. The ``after`` parameter must represent a member and meet the :class:`abc.Snowflake` abc. Examples --------- Usage :: # I do not actually recommend doing this. as...
[ "Returns", "an", ":", "class", ":", "AsyncIterator", "representing", "the", "users", "that", "have", "reacted", "to", "the", "message", "." ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/reaction.py#L124-L177
train
Rapptz/discord.py
discord/channel.py
TextChannel.members
def members(self): """Returns a :class:`list` of :class:`Member` that can see this channel.""" return [m for m in self.guild.members if self.permissions_for(m).read_messages]
python
def members(self): """Returns a :class:`list` of :class:`Member` that can see this channel.""" return [m for m in self.guild.members if self.permissions_for(m).read_messages]
[ "def", "members", "(", "self", ")", ":", "return", "[", "m", "for", "m", "in", "self", ".", "guild", ".", "members", "if", "self", ".", "permissions_for", "(", "m", ")", ".", "read_messages", "]" ]
Returns a :class:`list` of :class:`Member` that can see this channel.
[ "Returns", "a", ":", "class", ":", "list", "of", ":", "class", ":", "Member", "that", "can", "see", "this", "channel", "." ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/channel.py#L143-L145
train
Rapptz/discord.py
discord/channel.py
TextChannel.delete_messages
async def delete_messages(self, messages): """|coro| Deletes a list of messages. This is similar to :meth:`Message.delete` except it bulk deletes multiple messages. As a special case, if the number of messages is 0, then nothing is done. If the number of messages is 1 then sing...
python
async def delete_messages(self, messages): """|coro| Deletes a list of messages. This is similar to :meth:`Message.delete` except it bulk deletes multiple messages. As a special case, if the number of messages is 0, then nothing is done. If the number of messages is 1 then sing...
[ "async", "def", "delete_messages", "(", "self", ",", "messages", ")", ":", "if", "not", "isinstance", "(", "messages", ",", "(", "list", ",", "tuple", ")", ")", ":", "messages", "=", "list", "(", "messages", ")", "if", "len", "(", "messages", ")", "=...
|coro| Deletes a list of messages. This is similar to :meth:`Message.delete` except it bulk deletes multiple messages. As a special case, if the number of messages is 0, then nothing is done. If the number of messages is 1 then single message delete is done. If it's more than t...
[ "|coro|" ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/channel.py#L226-L274
train
Rapptz/discord.py
discord/channel.py
TextChannel.purge
async def purge(self, *, limit=100, check=None, before=None, after=None, around=None, oldest_first=False, bulk=True): """|coro| Purges a list of messages that meet the criteria given by the predicate ``check``. If a ``check`` is not provided then all messages are deleted without discrim...
python
async def purge(self, *, limit=100, check=None, before=None, after=None, around=None, oldest_first=False, bulk=True): """|coro| Purges a list of messages that meet the criteria given by the predicate ``check``. If a ``check`` is not provided then all messages are deleted without discrim...
[ "async", "def", "purge", "(", "self", ",", "*", ",", "limit", "=", "100", ",", "check", "=", "None", ",", "before", "=", "None", ",", "after", "=", "None", ",", "around", "=", "None", ",", "oldest_first", "=", "False", ",", "bulk", "=", "True", "...
|coro| Purges a list of messages that meet the criteria given by the predicate ``check``. If a ``check`` is not provided then all messages are deleted without discrimination. You must have the :attr:`~Permissions.manage_messages` permission to delete messages even if they are y...
[ "|coro|" ]
05d4f7f9620ef33635d6ac965b26528e09cdaf5b
https://github.com/Rapptz/discord.py/blob/05d4f7f9620ef33635d6ac965b26528e09cdaf5b/discord/channel.py#L276-L383
train