diff --git a/.github/workflows/build-and-publish.yml b/.github/workflows/build-and-publish.yml index c9080c55..af728aa2 100644 --- a/.github/workflows/build-and-publish.yml +++ b/.github/workflows/build-and-publish.yml @@ -17,6 +17,7 @@ jobs: - "attention-and-distributed-packing" - "accelerated-moe" - "online-data-mixing" + - "mamba-cp" permissions: id-token: write # IMPORTANT: this permission is mandatory for trusted publishing diff --git a/.github/workflows/format.yml b/.github/workflows/format.yml index 87efabe7..dc505645 100644 --- a/.github/workflows/format.yml +++ b/.github/workflows/format.yml @@ -32,6 +32,7 @@ jobs: - "attention-and-distributed-packing" - "accelerated-moe" - "online-data-mixing" + - "mamba-cp" steps: - name: Delete huge unnecessary tools folder diff --git a/.gitignore b/.gitignore index e50ac0ea..94bb46d9 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ __pycache__ *.tar.gz *.tox -*.pytest_cache \ No newline at end of file +*.pytest_cache +**/.DS_Store diff --git a/plugins/framework/src/fms_acceleration/constants.py b/plugins/framework/src/fms_acceleration/constants.py index 252842e0..0e8f522d 100644 --- a/plugins/framework/src/fms_acceleration/constants.py +++ b/plugins/framework/src/fms_acceleration/constants.py @@ -21,4 +21,4 @@ # and activated. # - hence the plugins that have model loaders should be on top of this list -PLUGINS = ["peft", "foak", "aadp", "moe", "odm"] +PLUGINS = ["peft", "foak", "aadp", "moe", "odm", "mcp"] diff --git a/plugins/mamba-cp/.isort.cfg b/plugins/mamba-cp/.isort.cfg new file mode 100644 index 00000000..7d3762ec --- /dev/null +++ b/plugins/mamba-cp/.isort.cfg @@ -0,0 +1,10 @@ +[settings] +profile=black +from_first=true +import_heading_future=Future +import_heading_stdlib=Standard +import_heading_thirdparty=Third Party +import_heading_firstparty=First Party +import_heading_localfolder=Local +known_firstparty= +known_localfolder=tuning \ No newline at end of file diff --git a/plugins/mamba-cp/.pylintrc b/plugins/mamba-cp/.pylintrc new file mode 100644 index 00000000..4dc16dbc --- /dev/null +++ b/plugins/mamba-cp/.pylintrc @@ -0,0 +1,649 @@ +[MAIN] + +# Analyse import fallback blocks. This can be used to support both Python 2 and +# 3 compatible code, which means that the block might have code that exists +# only in one or another interpreter, leading to false positives when analysed. +analyse-fallback-blocks=no + +# Clear in-memory caches upon conclusion of linting. Useful if running pylint +# in a server-like mode. +clear-cache-post-run=no + +# Load and enable all available extensions. Use --list-extensions to see a list +# all available extensions. +#enable-all-extensions= + +# In error mode, messages with a category besides ERROR or FATAL are +# suppressed, and no reports are done by default. Error mode is compatible with +# disabling specific errors. +#errors-only= + +# Always return a 0 (non-error) status code, even if lint errors are found. +# This is primarily useful in continuous integration scripts. +#exit-zero= + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code. +extension-pkg-allow-list= + +# A comma-separated list of package or module names from where C extensions may +# be loaded. Extensions are loading into the active Python interpreter and may +# run arbitrary code. (This is an alternative name to extension-pkg-allow-list +# for backward compatibility.) +extension-pkg-whitelist= + +# Return non-zero exit code if any of these messages/categories are detected, +# even if score is above --fail-under value. Syntax same as enable. Messages +# specified are enabled, while categories only check already-enabled messages. +fail-on= + +# Specify a score threshold under which the program will exit with error. +fail-under=10 + +# Interpret the stdin as a python script, whose filename needs to be passed as +# the module_or_package argument. +#from-stdin= + +# Files or directories to be skipped. They should be base names, not paths. +ignore=CVS,protobufs + +# Add files or directories matching the regular expressions patterns to the +# ignore-list. The regex matches against paths and can be in Posix or Windows +# format. Because '\\' represents the directory delimiter on Windows systems, +# it can't be used as an escape character. +ignore-paths=.*megablocks,.*khd + +# Files or directories matching the regular expression patterns are skipped. +# The regex matches against base names, not paths. The default value ignores +# Emacs file locks +ignore-patterns=^\.# + +# List of module names for which member attributes should not be checked +# (useful for modules/projects where namespaces are manipulated during runtime +# and thus existing member attributes cannot be deduced by static analysis). It +# supports qualified module names, as well as Unix pattern matching. +ignored-modules= + +# Python code to execute, usually for sys.path manipulation such as +# pygtk.require(). +#init-hook= + +# Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the +# number of processors available to use, and will cap the count on Windows to +# avoid hangs. +jobs=1 + +# Control the amount of potential inferred values when inferring a single +# object. This can help the performance when dealing with large functions or +# complex, nested conditions. +limit-inference-results=100 + +# List of plugins (as comma separated values of python module names) to load, +# usually to register additional checkers. +load-plugins= + +# Pickle collected data for later comparisons. +persistent=yes + +# Minimum Python version to use for version dependent checks. Will default to +# the version used to run pylint. +py-version=3.11 + +# Discover python modules and packages in the file system subtree. +recursive=no + +# When enabled, pylint would attempt to guess common misconfiguration and emit +# user-friendly hints instead of false-positive error messages. +suggestion-mode=yes + +# Allow loading of arbitrary C extensions. Extensions are imported into the +# active Python interpreter and may run arbitrary code. +unsafe-load-any-extension=no + +# In verbose mode, extra non-checker-related info will be displayed. +#verbose= + + +[BASIC] + +# Naming style matching correct argument names. +argument-naming-style=snake_case + +# Regular expression matching correct argument names. Overrides argument- +# naming-style. If left empty, argument names will be checked with the set +# naming style. +#argument-rgx= + +# Naming style matching correct attribute names. +attr-naming-style=snake_case + +# Regular expression matching correct attribute names. Overrides attr-naming- +# style. If left empty, attribute names will be checked with the set naming +# style. +#attr-rgx= + +# Bad variable names which should always be refused, separated by a comma. +bad-names=foo, + bar, + baz, + toto, + tutu, + tata + +# Bad variable names regexes, separated by a comma. If names match any regex, +# they will always be refused +bad-names-rgxs= + +# Naming style matching correct class attribute names. +class-attribute-naming-style=any + +# Regular expression matching correct class attribute names. Overrides class- +# attribute-naming-style. If left empty, class attribute names will be checked +# with the set naming style. +#class-attribute-rgx= + +# Naming style matching correct class constant names. +class-const-naming-style=UPPER_CASE + +# Regular expression matching correct class constant names. Overrides class- +# const-naming-style. If left empty, class constant names will be checked with +# the set naming style. +#class-const-rgx= + +# Naming style matching correct class names. +class-naming-style=PascalCase + +# Regular expression matching correct class names. Overrides class-naming- +# style. If left empty, class names will be checked with the set naming style. +#class-rgx= + +# Naming style matching correct constant names. +const-naming-style=UPPER_CASE + +# Regular expression matching correct constant names. Overrides const-naming- +# style. If left empty, constant names will be checked with the set naming +# style. +#const-rgx= + +# Minimum line length for functions/classes that require docstrings, shorter +# ones are exempt. +docstring-min-length=-1 + +# Naming style matching correct function names. +function-naming-style=snake_case + +# Regular expression matching correct function names. Overrides function- +# naming-style. If left empty, function names will be checked with the set +# naming style. +#function-rgx= + +# Good variable names which should always be accepted, separated by a comma. +good-names=i, + j, + k, + ex, + Run, + _ + +# Good variable names regexes, separated by a comma. If names match any regex, +# they will always be accepted +good-names-rgxs= + +# Include a hint for the correct naming format with invalid-name. +include-naming-hint=no + +# Naming style matching correct inline iteration names. +inlinevar-naming-style=any + +# Regular expression matching correct inline iteration names. Overrides +# inlinevar-naming-style. If left empty, inline iteration names will be checked +# with the set naming style. +#inlinevar-rgx= + +# Naming style matching correct method names. +method-naming-style=snake_case + +# Regular expression matching correct method names. Overrides method-naming- +# style. If left empty, method names will be checked with the set naming style. +#method-rgx= + +# Naming style matching correct module names. +module-naming-style=snake_case + +# Regular expression matching correct module names. Overrides module-naming- +# style. If left empty, module names will be checked with the set naming style. +#module-rgx= + +# Colon-delimited sets of names that determine each other's naming style when +# the name regexes allow several styles. +name-group= + +# Regular expression which should only match function or class names that do +# not require a docstring. +no-docstring-rgx=^_ + +# List of decorators that produce properties, such as abc.abstractproperty. Add +# to this list to register other decorators that produce valid properties. +# These decorators are taken in consideration only for invalid-name. +property-classes=abc.abstractproperty + +# Regular expression matching correct type variable names. If left empty, type +# variable names will be checked with the set naming style. +#typevar-rgx= + +# Naming style matching correct variable names. +variable-naming-style=snake_case + +# Regular expression matching correct variable names. Overrides variable- +# naming-style. If left empty, variable names will be checked with the set +# naming style. +#variable-rgx= + + +[CLASSES] + +# Warn about protected attribute access inside special methods +check-protected-access-in-special-methods=no + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__, + __new__, + setUp, + __post_init__ + +# List of member names, which should be excluded from the protected access +# warning. +exclude-protected=_asdict, + _fields, + _replace, + _source, + _make + +# List of valid names for the first argument in a class method. +valid-classmethod-first-arg=cls + +# List of valid names for the first argument in a metaclass class method. +valid-metaclass-classmethod-first-arg=mcs + + +[DESIGN] + +# List of regular expressions of class ancestor names to ignore when counting +# public methods (see R0903) +exclude-too-few-public-methods= + +# List of qualified class names to ignore when counting class parents (see +# R0901) +ignored-parents= + +# Maximum number of arguments for function / method. +max-args=5 + +# Maximum number of attributes for a class (see R0902). +max-attributes=8 + +# Maximum number of boolean expressions in an if statement (see R0916). +max-bool-expr=5 + +# Maximum number of branch for function / method body. +max-branches=12 + +# Maximum number of locals for function / method body. +max-locals=15 + +# Maximum number of parents for a class (see R0901). +max-parents=7 + +# Maximum number of public methods for a class (see R0904). +max-public-methods=20 + +# Maximum number of return / yield for function / method body. +max-returns=6 + +# Maximum number of statements in function / method body. +max-statements=50 + +# Minimum number of public methods for a class (see R0903). +min-public-methods=2 + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when caught. +overgeneral-exceptions=builtins.BaseException,builtins.Exception + + +[FORMAT] + +# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. +expected-line-ending-format= + +# Regexp for a line that is allowed to be longer than the limit. +ignore-long-lines=^\s*(# )??$ + +# Number of spaces of indent required inside a hanging or continued line. +indent-after-paren=4 + +# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 +# tab). +indent-string=' ' + +# Maximum number of characters on a single line. +max-line-length=100 + +# Maximum number of lines in a module. +max-module-lines=1100 + +# Allow the body of a class to be on the same line as the declaration if body +# contains single statement. +single-line-class-stmt=no + +# Allow the body of an if to be on the same line as the test if there is no +# else. +single-line-if-stmt=no + + +[IMPORTS] + +# List of modules that can be imported at any level, not just the top level +# one. +allow-any-import-level= + +# Allow explicit reexports by alias from a package __init__. +allow-reexport-from-package=no + +# Allow wildcard imports from modules that define __all__. +allow-wildcard-with-all=no + +# Deprecated modules which should not be used, separated by a comma. +deprecated-modules= + +# Output a graph (.gv or any supported image format) of external dependencies +# to the given file (report RP0402 must not be disabled). +ext-import-graph= + +# Output a graph (.gv or any supported image format) of all (i.e. internal and +# external) dependencies to the given file (report RP0402 must not be +# disabled). +import-graph= + +# Output a graph (.gv or any supported image format) of internal dependencies +# to the given file (report RP0402 must not be disabled). +int-import-graph= + +# Force import order to recognize a module as part of the standard +# compatibility libraries. +known-standard-library= + +# Force import order to recognize a module as part of a third party library. +known-third-party=enchant + +# Couples of modules and preferred modules, separated by a comma. +preferred-modules= + + +[LOGGING] + +# The type of string formatting that logging methods do. `old` means using % +# formatting, `new` is for `{}` formatting. +logging-format-style=old + +# Logging modules to check that the string format arguments are in logging +# function parameter format. +logging-modules=logging + + +[MESSAGES CONTROL] + +# Only show warnings with the listed confidence levels. Leave empty to show +# all. Valid levels: HIGH, CONTROL_FLOW, INFERENCE, INFERENCE_FAILURE, +# UNDEFINED. +confidence=HIGH, + CONTROL_FLOW, + INFERENCE, + INFERENCE_FAILURE, + UNDEFINED + +# Disable the message, report, category or checker with the given id(s). You +# can either give multiple identifiers separated by comma (,) or put this +# option multiple times (only on the command line, not in the configuration +# file where it should appear only once). You can also use "--disable=all" to +# disable everything first and then re-enable specific checks. For example, if +# you want to run only the similarities checker, you can use "--disable=all +# --enable=similarities". If you want to run only the classes checker, but have +# no Warning level messages displayed, use "--disable=all --enable=classes +# --disable=W". +disable=raw-checker-failed, + bad-inline-option, + locally-disabled, + file-ignored, + suppressed-message, + useless-suppression, + deprecated-pragma, + # Added messages + use-symbolic-message-instead, + invalid-name, + missing-class-docstring, + missing-module-docstring, + missing-function-docstring, + consider-using-f-string, + inconsistent-return-statements, + no-member, + too-many-arguments, + too-many-locals, + too-many-branches, + too-many-statements, + cyclic-import, + too-few-public-methods, + protected-access, + fixme, + logging-format-interpolation, + logging-too-many-args, + attribute-defined-outside-init, + abstract-method, + pointless-statement, + wrong-import-order, + duplicate-code, + unbalanced-tuple-unpacking, + unused-argument + +# Enable the message, report, category or checker with the given id(s). You can +# either give multiple identifier separated by comma (,) or put this option +# multiple time (only on the command line, not in the configuration file where +# it should appear only once). See also the "--disable" option for examples. +enable=c-extension-no-member + + +[METHOD_ARGS] + +# List of qualified names (i.e., library.method) which require a timeout +# parameter e.g. 'requests.api.get,requests.api.post' +timeout-methods=requests.api.delete,requests.api.get,requests.api.head,requests.api.options,requests.api.patch,requests.api.post,requests.api.put,requests.api.request + + +[MISCELLANEOUS] + +# List of note tags to take in consideration, separated by a comma. +notes=FIXME, + XXX, + TODO + +# Regular expression of note tags to take in consideration. +notes-rgx= + + +[REFACTORING] + +# Maximum number of nested blocks for function / method body +max-nested-blocks=5 + +# Complete name of functions that never returns. When checking for +# inconsistent-return-statements if a never returning function is called then +# it will be considered as an explicit return statement and no message will be +# printed. +never-returning-functions=sys.exit,argparse.parse_error + + +[REPORTS] + +# Python expression which should return a score less than or equal to 10. You +# have access to the variables 'fatal', 'error', 'warning', 'refactor', +# 'convention', and 'info' which contain the number of messages in each +# category, as well as 'statement' which is the total number of statements +# analyzed. This score is used by the global evaluation report (RP0004). +evaluation=max(0, 0 if fatal else 10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)) + +# Template used to display messages. This is a python new-style format string +# used to format the message information. See doc for all details. +msg-template= + +# Set the output format. Available formats are text, parseable, colorized, json +# and msvs (visual studio). You can also give a reporter class, e.g. +# mypackage.mymodule.MyReporterClass. +output-format=text + +# Tells whether to display a full report or only the messages. +reports=yes + +# Activate the evaluation score. +score=yes + + +[SIMILARITIES] + +# Comments are removed from the similarity computation +ignore-comments=yes + +# Docstrings are removed from the similarity computation +ignore-docstrings=yes + +# Imports are removed from the similarity computation +ignore-imports=yes + +# Signatures are removed from the similarity computation +ignore-signatures=yes + +# Minimum lines number of a similarity. +min-similarity-lines=4 + + +[SPELLING] + +# Limits count of emitted suggestions for spelling mistakes. +max-spelling-suggestions=4 + +# Spelling dictionary name. Available dictionaries: none. To make it work, +# install the 'python-enchant' package. +spelling-dict= + +# List of comma separated words that should be considered directives if they +# appear at the beginning of a comment and should not be checked. +spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy: + +# List of comma separated words that should not be checked. +spelling-ignore-words= + +# A path to a file that contains the private dictionary; one word per line. +spelling-private-dict-file= + +# Tells whether to store unknown words to the private dictionary (see the +# --spelling-private-dict-file option) instead of raising a message. +spelling-store-unknown-words=no + + +[STRING] + +# This flag controls whether inconsistent-quotes generates a warning when the +# character used as a quote delimiter is used inconsistently within a module. +check-quote-consistency=no + +# This flag controls whether the implicit-str-concat should generate a warning +# on implicit string concatenation in sequences defined over several lines. +check-str-concat-over-line-jumps=no + + +[TYPECHECK] + +# List of decorators that produce context managers, such as +# contextlib.contextmanager. Add to this list to register other decorators that +# produce valid context managers. +contextmanager-decorators=contextlib.contextmanager + +# List of members which are set dynamically and missed by pylint inference +# system, and so shouldn't trigger E1101 when accessed. Python regular +# expressions are accepted. +generated-members= + +# Tells whether to warn about missing members when the owner of the attribute +# is inferred to be None. +ignore-none=yes + +# This flag controls whether pylint should warn about no-member and similar +# checks whenever an opaque object is returned when inferring. The inference +# can return multiple potential results while evaluating a Python object, but +# some branches might not be evaluated, which results in partial inference. In +# that case, it might be useful to still emit no-member and other checks for +# the rest of the inferred objects. +ignore-on-opaque-inference=yes + +# List of symbolic message names to ignore for Mixin members. +ignored-checks-for-mixins=no-member, + not-async-context-manager, + not-context-manager, + attribute-defined-outside-init + +# List of class names for which member attributes should not be checked (useful +# for classes with dynamically set attributes). This supports the use of +# qualified names. +ignored-classes=optparse.Values,thread._local,_thread._local,argparse.Namespace + +# Show a hint with possible names when a member name was not found. The aspect +# of finding the hint is based on edit distance. +missing-member-hint=yes + +# The minimum edit distance a name should have in order to be considered a +# similar match for a missing member name. +missing-member-hint-distance=1 + +# The total number of similar names that should be taken in consideration when +# showing a hint for a missing member. +missing-member-max-choices=1 + +# Regex pattern to define which classes are considered mixins. +mixin-class-rgx=.*[Mm]ixin + +# List of decorators that change the signature of a decorated function. +signature-mutators= + + +[VARIABLES] + +# List of additional names supposed to be defined in builtins. Remember that +# you should avoid defining new builtins when possible. +additional-builtins= + +# Tells whether unused global variables should be treated as a violation. +allow-global-unused-variables=yes + +# List of names allowed to shadow builtins +allowed-redefined-builtins= + +# List of strings which can identify a callback function by name. A callback +# name must start or end with one of those strings. +callbacks=cb_, + _cb + +# A regular expression matching the name of dummy variables (i.e. expected to +# not be used). +dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ + +# Argument names that match this expression will be ignored. +ignored-argument-names=_.*|^ignored_|^unused_ + +# Tells whether we should check for unused import in __init__ files. +init-import=no + +# List of qualified module names which can have objects that can redefine +# builtins. +redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io \ No newline at end of file diff --git a/plugins/mamba-cp/README.md b/plugins/mamba-cp/README.md new file mode 100644 index 00000000..1a0c2127 --- /dev/null +++ b/plugins/mamba-cp/README.md @@ -0,0 +1,17 @@ +# Context Parallel for Mamba Kernels + +This library contains plugin for applying context parallelism for mamba module (mamba_ssm). + +## Plugins + +Plugin | Description | Depends | Loading | Augmentation | Callbacks +--|--|--|--|--|-- +[mcp](./src/fms_acceleration_mcp/framework_plugin_mcp.py) | context parallel for mamba | [custom mamba cp implementation](https://github.com/garrett361/mamba/tree/mamba-cp) | ✅ | ✅ | ✅ + +## Mamba CP Implementation + +Context parallel implementation is taken from a custom [mamba_ssm repo](https://github.com/garrett361/mamba/tree/mamba-cp) with cp implemenation. Thus, its required this repo is installed to use this plugin. + +## Known Issues +1. load balancing is removed given limited support on mamba cp implementation. This could lead to potential throughput drops for trainings using causal mask. +2. Padding free and flash attention are not supported. \ No newline at end of file diff --git a/plugins/mamba-cp/configs/mcp.yaml b/plugins/mamba-cp/configs/mcp.yaml new file mode 100644 index 00000000..6194c313 --- /dev/null +++ b/plugins/mamba-cp/configs/mcp.yaml @@ -0,0 +1,4 @@ +training: + mamba: + cp: + degree: 2 # cp degree diff --git a/plugins/mamba-cp/pyproject.toml b/plugins/mamba-cp/pyproject.toml new file mode 100644 index 00000000..67948cbd --- /dev/null +++ b/plugins/mamba-cp/pyproject.toml @@ -0,0 +1,29 @@ +[build-system] +requires = ["hatchling"] +build-backend = "hatchling.build" + +[project] +name = "fms-acceleration-mcp" +version = '0.1.1.dev' +description = "FMS Acceleration plugin for context parallel for mamba kernels" +authors = [ + {name = "Mehant Kammakomati", email = "mehant.kammakomati2@ibm.com"}, +] +license = {text = "Apache-2.0"} +readme = "README.md" +requires-python = "~=3.11" +keywords = ['fms-hf-tuning', 'acceleration', 'mamba-cp'] +classifiers=[ + "License :: OSI Approved :: Apache Software License", + "Development Status :: 4 - Beta", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.11", +] + +dependencies = ["pytest"] + +[tool.hatch.build.targets.wheel] +only-include = ["src/fms_acceleration_mcp"] + +[tool.hatch.build.targets.wheel.sources] +"src" = "" diff --git a/plugins/mamba-cp/src/fms_acceleration_mcp/__init__.py b/plugins/mamba-cp/src/fms_acceleration_mcp/__init__.py new file mode 100644 index 00000000..1e80026a --- /dev/null +++ b/plugins/mamba-cp/src/fms_acceleration_mcp/__init__.py @@ -0,0 +1,17 @@ +# Copyright The FMS HF Tuning Authors +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +# Local +from .framework_plugin_mcp import MCPAccelerationPlugin diff --git a/plugins/mamba-cp/src/fms_acceleration_mcp/framework_plugin_mcp.py b/plugins/mamba-cp/src/fms_acceleration_mcp/framework_plugin_mcp.py new file mode 100644 index 00000000..9850cb51 --- /dev/null +++ b/plugins/mamba-cp/src/fms_acceleration_mcp/framework_plugin_mcp.py @@ -0,0 +1,87 @@ +# Copyright The FMS HF Tuning Authors +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Standard +from typing import Dict, Tuple + +# Third Party +from fms_acceleration import AccelerationPlugin +from peft import LoraConfig +from transformers import TrainingArguments +import torch + +# Local +from .utils import patch_mamba_layers_with_cp_head + + +# pylint: disable=too-many-instance-attributes +class MCPAccelerationPlugin(AccelerationPlugin): + + def __init__(self, configurations: Dict[str, Dict]): + super().__init__(configurations) + self._mamba_cp_degree = self._check_config_and_maybe_check_values( + key="training.mamba.cp.degree", + default=None, + ) + self._cp_mamba_impl = self._check_config_and_maybe_check_values( + key="training.mamba.cp.mamba_impl", + default="allgather", + ) + self._cp_mamba_recompute = self._check_config_and_maybe_check_values( + key="training.mamba.cp.mamba_recompute", + default=False, + ) + + # data_config file should be there + @property + def requires_augmentation(self): + return True + + def augmentation( + self, + model, + train_args: TrainingArguments, + modifiable_args: Tuple[LoraConfig], + ): + if self._mamba_cp_degree is not None: + rank = 0 + if torch.distributed.is_initialized(): + rank = torch.distributed.get_node_local_rank() + world_size = torch.distributed.get_world_size() + model_name = model.config.name_or_path + patch_mamba_layers_with_cp_head( + model=model, + checkpoint_name_or_path=model_name, + rank=rank, + cp_degree=self._mamba_cp_degree, + world_size=world_size, + cp_mamba_impl=self._cp_mamba_impl, + cp_mamba_recompute=self._cp_mamba_recompute, + ) + return model, modifiable_args + + def get_callbacks_and_ready_for_train( + self, model: torch.nn.Module = None, accelerator=None + ): + callbacks = [] + return callbacks + + +# register +AccelerationPlugin.register_plugin( + MCPAccelerationPlugin, + configuration_and_paths=[ + "training.mamba.cp", + ], +) diff --git a/plugins/mamba-cp/src/fms_acceleration_mcp/utils/__init__.py b/plugins/mamba-cp/src/fms_acceleration_mcp/utils/__init__.py new file mode 100644 index 00000000..76d835af --- /dev/null +++ b/plugins/mamba-cp/src/fms_acceleration_mcp/utils/__init__.py @@ -0,0 +1,16 @@ +# Copyright The FMS HF Tuning Authors +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Local +from .utils import patch_mamba_layers_with_cp_head diff --git a/plugins/mamba-cp/src/fms_acceleration_mcp/utils/utils.py b/plugins/mamba-cp/src/fms_acceleration_mcp/utils/utils.py new file mode 100644 index 00000000..7fdf6c64 --- /dev/null +++ b/plugins/mamba-cp/src/fms_acceleration_mcp/utils/utils.py @@ -0,0 +1,140 @@ +# Copyright The FMS HF Tuning Authors +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# Standard +from typing import Dict + +try: + # Third Party + from mamba_ssm.modules.mamba2_cp import Mamba2CP +except ImportError as exc: + raise ValueError( + "custom mamba_ssm package installation is needed" + "install from https://github.com/garrett361/mamba/tree/mamba-cp" + ) from exc +# Third Party +from accelerate.logging import get_logger + +# pylint: disable=import-error +from torch.distributed._tensor.device_mesh import init_device_mesh + +# to avoid rechunking/sharding of the buffers +# ideally this is not optimal +# this is done to make self attention cp compatible with mamba cp +from torch.distributed.tensor.experimental._attention import _cp_options +from tqdm import tqdm +from transformers.modeling_utils import is_fsdp_enabled +import torch + +_cp_options.enable_load_balance = False + +logger = get_logger(__name__) + +# the same keys are used in accelerate +# therefore we choose these to be in sync and cross leverage. +key_cp = "cp" +key_rep = "dp_shard" + + +# extract ssm config from hf config to be used +# while swapping the mamba modules +def get_ssmconfig_from_hfconfig(hf_config) -> Dict: + config_ssm = {} + config_ssm["d_model"] = hf_config.hidden_size + config_ssm["d_state"] = 128 + config_ssm["ngroups"] = hf_config.mamba_n_groups + config_ssm["rmsnorm"] = True + config_ssm["chunk_size"] = hf_config.mamba_chunk_size + config_ssm["conv_bias"] = hf_config.mamba_conv_bias + config_ssm["d_conv"] = hf_config.mamba_d_conv + return config_ssm + + +# to patch input arguments between mamba cp module and standard hf mamba module +class Mamba2CPHF(Mamba2CP): + def forward( + self, + hidden_states, + cache_params=None, + cache_position=None, + attention_mask=None, + seq_idx=None, + **kwargs, + ): + return super().forward( + u=hidden_states, + seqlen=None, + seq_idx=None, + cu_seqlens=None, + inference_params=None, + ) + + +# patches each mamba module with mamba cp module +# mamba cp module's weights are exactly same as hf mamba module +# so we reuse the state dict and the same does not need special handling +# while checkpointing. +def patch_mamba_layers_with_cp_head( + model, + checkpoint_name_or_path, + rank, + cp_degree, + world_size, + cp_mamba_impl, + cp_mamba_recompute, +): + + config_ssm = get_ssmconfig_from_hfconfig(model.config) + device = torch.device(f"cuda:{rank}") + if is_fsdp_enabled(): + device = torch.device("cpu") + rep_size = world_size // cp_degree + + # auto infer ddp and cp ranks + # does not work on other combination of parallelisms + logger.warning( + "Mamba CP is only meant for parallelism combinations having DP and CP" + "other combinations can lead to unexpected behaviour" + ) + if cp_degree == 1: + raise ValueError("CP degree can't be one") + if rep_size == 1: + device_mesh = init_device_mesh( + "cuda", + (cp_degree,), + mesh_dim_names=(key_cp,), + ) + else: + device_mesh = init_device_mesh( + "cuda", + (rep_size, cp_degree), + mesh_dim_names=(key_rep, key_cp), + ) + + cp_args = { + "cp_mesh": device_mesh[key_cp], + "cp_mamba_impl": cp_mamba_impl, + "cp_mamba_recompute": cp_mamba_recompute, + } + with torch.no_grad(): + dtype = model.dtype + device = model.device + for layer in tqdm(model.model.layers, desc="Swapping mamba layers"): + if hasattr(layer, "mamba") and layer.mamba is not None: + mamba_layer = Mamba2CPHF(**config_ssm, **cp_args) + mamba_layer.load_state_dict(layer.mamba.state_dict()) + setattr(layer, "mamba", mamba_layer) + layer.to(dtype).to(device) + + if hasattr(model, "tie_weights"): + model.tie_weights() diff --git a/plugins/mamba-cp/tests/__init__.py b/plugins/mamba-cp/tests/__init__.py new file mode 100644 index 00000000..38a9531e --- /dev/null +++ b/plugins/mamba-cp/tests/__init__.py @@ -0,0 +1,13 @@ +# Copyright The FMS HF Tuning Authors +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. diff --git a/plugins/mamba-cp/tests/test_mcp_plugin.py b/plugins/mamba-cp/tests/test_mcp_plugin.py new file mode 100644 index 00000000..c62c7d8f --- /dev/null +++ b/plugins/mamba-cp/tests/test_mcp_plugin.py @@ -0,0 +1,43 @@ +# Copyright The FMS HF Tuning Authors +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# Standard +import os + +# Third Party +import pytest + +# configuration +DIRNAME = os.path.dirname(__file__) +CONFIG_PATH = os.path.join(DIRNAME, "../configs/mcp.yaml") + + +@pytest.mark.skipif( + not pytest.importorskip("mamba_ssm", reason="mamba_ssm is not installed"), + reason="mamba_ssm is not installed", +) +def test_framework_installs_mcp_plugin(): + # Third Party + # pylint: disable=import-outside-toplevel + from fms_acceleration.utils import instantiate_framework, read_configuration + + # First Party + # pylint: disable=import-outside-toplevel + from fms_acceleration_mcp import MCPAccelerationPlugin + + with instantiate_framework( + read_configuration(CONFIG_PATH), require_packages_check=False + ) as framework: + for plugin in framework.active_plugins: + assert isinstance(plugin[1], MCPAccelerationPlugin) diff --git a/plugins/mamba-cp/tox.ini b/plugins/mamba-cp/tox.ini new file mode 100644 index 00000000..ba3e7209 --- /dev/null +++ b/plugins/mamba-cp/tox.ini @@ -0,0 +1,53 @@ +[tox] +envlist = py, lint + +[testenv] +deps = + pytest>=7 + importlib-metadata + -e {toxinidir} +skip_install = true +commands = + + # install the dependencies here to ensure + # the order + pip install -e {toxinidir}/../framework + # if all tests skipped + # pytest should not report fail + bash -c 'pytest {posargs:tests}; ec=$?; [ "$ec" = "5" ] && exit 0 || exit $ec' +allowlist_externals = bash + +[testenv:lint] +description = run linters +skip_install = false +deps = + -e {toxinidir}/../framework + pylint>=2.16.2,<=3.1.0 + datasets() +commands = + pylint src tests +allowlist_externals = pylint + +[testenv:fmt] +description = format +skip_install = true +deps = + black>=22.12 + isort>=5.11 +commands = + black {posargs:.} + isort {posargs:.} + +[testenv:build] +description = build wheel +deps = + build +commands = python -m build -w +skip_install = True + +[testenv:twinecheck] +description = check wheel +deps = + twine +commands = twine check dist/* +skip_install = True \ No newline at end of file