Dataclass error while importing Fairseq in Python 3.11 #5012

usaraj · 2023-03-07T05:05:00Z

🐛 Bug

FaValueError: mutable default <class 'fairseq.dataclass.configs.CommonConfig'> for field common is not allowed: use default_factory

To Reproduce

Steps to reproduce the behavior (always include the command you ran):
1, pip install fairseq==0.12.2
2. from fairseq import *

Trace:

Traceback (most recent call last):
File "", line 1, in
File "/home/a1bharat/fairseq/fairseq/init.py", line 20, in
from fairseq.distributed import utils as distributed_utils
File "/home/a1bharat/fairseq/fairseq/distributed/init.py", line 7, in
from .legacy_distributed_data_parallel import LegacyDistributedDataParallel
File "/home/a1bharat/fairseq/fairseq/distributed/legacy_distributed_data_parallel.py", line 23, in
from fairseq.distributed import utils
File "/home/a1bharat/fairseq/fairseq/distributed/utils.py", line 22, in
from fairseq.dataclass.configs import DistributedTrainingConfig, FairseqConfig
File "/home/a1bharat/fairseq/fairseq/dataclass/init.py", line 6, in
from .configs import FairseqDataclass
File "/home/a1bharat/fairseq/fairseq/dataclass/configs.py", line 906, in
@DataClass
^^^^^^^^^
File "/usr/lib/python3.11/dataclasses.py", line 1220, in dataclass
return wrap(cls)
^^^^^^^^^
File "/usr/lib/python3.11/dataclasses.py", line 1210, in wrap
return _process_class(cls, init, repr, eq, order, unsafe_hash,
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/usr/lib/python3.11/dataclasses.py", line 958, in _process_class
cls_fields.append(_get_field(cls, name, type, kw_only))
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/usr/lib/python3.11/dataclasses.py", line 815, in _get_field
raise ValueError(f'mutable default {type(f.default)} for field '
ValueError: mutable default <class 'fairseq.dataclass.configs.CommonConfig'> for field common is not allowed: use default_factory

Code sample

Environment

fairseq Version ( main):
PyTorch Version (e.g., 1.0): 1.13.1
OS (e.g., Linux): Ubuntu
How you installed fairseq (pip, source): pip install successful
Build command you used (if compiling from source): git clone followed by pip install ./
Python version: 3.11
CUDA/cuDNN version: 11.6
GPU models and configuration: NVIDIA
Any other relevant information:

Additional context

The text was updated successfully, but these errors were encountered:

VarunGumma · 2023-03-13T06:24:02Z

Is Pytorch supporting python 3.11?

EmreOzkose · 2023-03-22T13:04:03Z

Hi, is there any progress on this issue?

EmreOzkose · 2023-03-22T13:14:39Z

I created another conda environment with python 3.9, and didn't face with this error.

VarunGumma · 2023-03-22T13:27:49Z

@EmreOzkose Yes, Pytorch2.0 supports Python 3.11

Birch-san · 2023-04-02T00:51:20Z

fairseq/fairseq/dataclass/configs.py

Line 1129 in 176cd93

common: CommonConfig = CommonConfig()

I assume it wants something like this:

@dataclass
class FairseqConfig(FairseqDataclass):
-     common: CommonConfig = CommonConfig()
+     common: CommonConfig = field(default_factory=CommonConfig)

conan1024hao · 2023-04-07T01:50:38Z

same problem

ashesfall · 2023-04-09T16:11:34Z

Experiencing this with 3.11.2.

Muskan19577 · 2023-05-01T14:54:28Z

I am also facing the same issue. any way to resolve this?

ashesfall · 2023-05-01T15:09:17Z

@Muskan19577 I had to move back to python 3.9

thyripian · 2023-06-05T00:01:17Z

I have this same issue running Python 3.11.3, and the config.py modifications suggested did not resolve the issue. Looks like the issues migrated to the hydra module, based on the traceback. Please advise. Traceback below.

bit-scientist · 2023-08-09T02:03:26Z

getting the same ValeError iwth Python 3.11.4. Any suggestions?

One-sixth · 2023-08-11T21:03:52Z

The official fix is too slow, I made a fix version myself.
You can install it using the following command.
v0.12.3.
I conducted a simple test and found no abnormalities.

pip install git+https://github.com/One-sixth/fairseq.git

kabyanil · 2023-09-26T10:05:25Z

This issue still exists on the official release. I'm using Python 3.11.

zhiqu22 · 2023-10-05T05:57:33Z

This issue still exists on the official release. I'm using Python 3.11.

Same error with Python 3.11.5

MrGutarLed · 2023-10-08T20:30:10Z

Same error with Python 3.11

JingThree3 · 2023-10-18T11:02:47Z

Same error with Python 3.11.6 😥

aikow · 2023-10-18T15:59:20Z

The changes to dataclasses are an official change that was introduced in python 3.11, meaning all 3.11.x and higher won't work. This will need to get changed in fairseq's codebase, and isnt dependent on the exact python 3.11.x version

Y-H-Joe · 2023-11-24T08:06:56Z

Python 3.11.4 (main, Jul  5 2023, 14:15:25) [GCC 11.2.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> import fairseq
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/home/users/nus/zyh/anaconda3/lib/python3.11/site-packages/fairseq/__init__.py", line 20, in <module>
    from fairseq.distributed import utils as distributed_utils
  File "/home/users/nus/zyh/anaconda3/lib/python3.11/site-packages/fairseq/distributed/__init__.py", line 7, in <module>
    from .fully_sharded_data_parallel import (
  File "/home/users/nus/zyh/anaconda3/lib/python3.11/site-packages/fairseq/distributed/fully_sharded_data_parallel.py", line 10, in <module>
    from fairseq.dataclass.configs import DistributedTrainingConfig
  File "/home/users/nus/zyh/anaconda3/lib/python3.11/site-packages/fairseq/dataclass/__init__.py", line 6, in <module>
    from .configs import FairseqDataclass
  File "/home/users/nus/zyh/anaconda3/lib/python3.11/site-packages/fairseq/dataclass/configs.py", line 1104, in <module>
    @dataclass
     ^^^^^^^^^
  File "/home/users/nus/zyh/anaconda3/lib/python3.11/dataclasses.py", line 1230, in dataclass
    return wrap(cls)
           ^^^^^^^^^
  File "/home/users/nus/zyh/anaconda3/lib/python3.11/dataclasses.py", line 1220, in wrap
    return _process_class(cls, init, repr, eq, order, unsafe_hash,
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/users/nus/zyh/anaconda3/lib/python3.11/dataclasses.py", line 958, in _process_class
    cls_fields.append(_get_field(cls, name, type, kw_only))
                      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/users/nus/zyh/anaconda3/lib/python3.11/dataclasses.py", line 815, in _get_field
    raise ValueError(f'mutable default {type(f.default)} for field '
ValueError: mutable default <class 'fairseq.dataclass.configs.CommonConfig'> for field common is not allowed: use default_factory

CircuitCM · 2023-12-15T13:17:06Z

I'm confused. Why is this still not fixed? Will it break backwards compatibility?

liyaodev · 2024-01-10T04:07:15Z

I have encountered these problems, and here is my solution:
Windows11 environment

pip install git+https://github.com/liyaodev/fairseq.git

or, download fairseq-0.12.3.1-cp311-cp311-linux_x86_64.whl

pip install./fairseq-0.12.3.1-cp311-cp311-linux_x86_64.whl

WSL2(Ubuntu22.04) environment(my local use)

pip install git+https://github.com/liyaodev/fairseq.git

or, download fairseq-0.12.3.1-cp311-cp311-linux_x86_64.whl

pip install./fairseq-0.12.3.1-cp311-cp311-linux_x86_64.whl

there's a little tip, best use hydra-core==1.3.2 omegaconf==2.3.0

Fmstrat · 2024-04-13T14:34:31Z

Figured since it's April now, I'd throw in my two cents. Still not working.

yjyuanjin · 2024-04-15T11:19:07Z

fairseq/fairseq/dataclass/configs.py

Line 1129 in 176cd93

common: CommonConfig = CommonConfig()

I assume it wants something like this:
@dataclass
class FairseqConfig(FairseqDataclass):
-     common: CommonConfig = CommonConfig()
+     common: CommonConfig = field(default_factory=CommonConfig)

Thanks, it work for me. I change all the error place like your suggestion.

last-fisherman · 2024-04-15T16:23:36Z

@liyaodev, could you please tell me what the exact name of the package you mentioned would be for Windows?

liyaodev · 2024-04-16T06:22:24Z

@liyaodev, could you please tell me what the exact name of the package you mentioned would be for Windows?

Windows 11 Professional

snoop2head · 2024-04-26T23:26:06Z

Not working in CentOS, Python 3.11

tavyscrolls · 2024-05-04T20:26:42Z

So uh, still not working in Python 3.12 😅 Compile from source fixes tho

ZeaMays14142 · 2024-05-22T20:01:47Z

problem still up and critical

ZeaMays14142 · 2024-05-22T20:02:27Z

I have encountered these problems, and here is my solution: Windows11 environment
pip install git+https://github.com/liyaodev/fairseq.git
or, download fairseq-0.12.3.1-cp311-cp311-linux_x86_64.whl
pip install./fairseq-0.12.3.1-cp311-cp311-linux_x86_64.whl
WSL2(Ubuntu22.04) environment(my local use)
pip install git+https://github.com/liyaodev/fairseq.git
or, download fairseq-0.12.3.1-cp311-cp311-linux_x86_64.whl
pip install./fairseq-0.12.3.1-cp311-cp311-linux_x86_64.whl
there's a little tip, best use hydra-core==1.3.2 omegaconf==2.3.0

does this still work?

neph-64 · 2024-05-25T23:32:09Z

This is what I get.

Traceback (most recent call last):
  File "C:\Users\neph\rvc-tts-webui\app.py", line 12, in <module>
    from fairseq import checkpoint_utils
  File "C:\Users\neph\rvc-tts-webui\venv\Lib\site-packages\fairseq\__init__.py", line 20, in <module>
    from fairseq.distributed import utils as distributed_utils
  File "C:\Users\neph\rvc-tts-webui\venv\Lib\site-packages\fairseq\distributed\__init__.py", line 7, in <module>
    from .fully_sharded_data_parallel import (
  File "C:\Users\neph\rvc-tts-webui\venv\Lib\site-packages\fairseq\distributed\fully_sharded_data_parallel.py", line 10, in <module>
    from fairseq.dataclass.configs import DistributedTrainingConfig
  File "C:\Users\neph\rvc-tts-webui\venv\Lib\site-packages\fairseq\dataclass\__init__.py", line 6, in <module>
    from .configs import FairseqDataclass
  File "C:\Users\neph\rvc-tts-webui\venv\Lib\site-packages\fairseq\dataclass\configs.py", line 1104, in <module>
    @dataclass
     ^^^^^^^^^
  File "C:\Program Files\WindowsApps\PythonSoftwareFoundation.Python.3.12_3.12.1008.0_x64__qbz5n2kfra8p0\Lib\dataclasses.py", line 1268, in dataclass
    return wrap(cls)
           ^^^^^^^^^
  File "C:\Program Files\WindowsApps\PythonSoftwareFoundation.Python.3.12_3.12.1008.0_x64__qbz5n2kfra8p0\Lib\dataclasses.py", line 1258, in wrap
    return _process_class(cls, init, repr, eq, order, unsafe_hash,
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Program Files\WindowsApps\PythonSoftwareFoundation.Python.3.12_3.12.1008.0_x64__qbz5n2kfra8p0\Lib\dataclasses.py", line 994, in _process_class
    cls_fields.append(_get_field(cls, name, type, kw_only))
                      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "C:\Program Files\WindowsApps\PythonSoftwareFoundation.Python.3.12_3.12.1008.0_x64__qbz5n2kfra8p0\Lib\dataclasses.py", line 852, in _get_field
    raise ValueError(f'mutable default {type(f.default)} for field '
ValueError: mutable default <class 'fairseq.dataclass.configs.CommonConfig'> for field common is not allowed: use default_factory
(venv) PS C:\Users\neph\rvc-tts-webui> pip install git+https://github.com/liyaodev/fairseq.git
Collecting git+https://github.com/liyaodev/fairseq.git
  Cloning https://github.com/liyaodev/fairseq.git to c:\users\neph\appdata\local\temp\pip-req-build-ktcozen9
  Running command git clone --filter=blob:none --quiet https://github.com/liyaodev/fairseq.git 'C:\Users\neph\AppData\Local\Temp\pip-req-build-ktcozen9'
  Resolved https://github.com/liyaodev/fairseq.git to commit b963eac7a04c539ad59fb1e23277f2ff7ee29e74
  Running command git submodule update --init --recursive -q
  Installing build dependencies ... done
  Getting requirements to build wheel ... error
  error: subprocess-exited-with-error

  × Getting requirements to build wheel did not run successfully.
  │ exit code: 1
  ╰─> [18 lines of output]
      Traceback (most recent call last):
        File "C:\Users\neph\rvc-tts-webui\venv\Lib\site-packages\pip\_vendor\pyproject_hooks\_in_process\_in_process.py", line 353, in <module>
          main()
        File "C:\Users\neph\rvc-tts-webui\venv\Lib\site-packages\pip\_vendor\pyproject_hooks\_in_process\_in_process.py", line 335, in main
          json_out['return_val'] = hook(**hook_input['kwargs'])
                                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        File "C:\Users\neph\rvc-tts-webui\venv\Lib\site-packages\pip\_vendor\pyproject_hooks\_in_process\_in_process.py", line 118, in get_requires_for_build_wheel
          return hook(config_settings)
                 ^^^^^^^^^^^^^^^^^^^^^
        File "C:\Users\neph\AppData\Local\Temp\pip-build-env-1tdzldxr\overlay\Lib\site-packages\setuptools\build_meta.py", line 325, in get_requires_for_build_wheel
          return self._get_build_requires(config_settings, requirements=['wheel'])
                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        File "C:\Users\neph\AppData\Local\Temp\pip-build-env-1tdzldxr\overlay\Lib\site-packages\setuptools\build_meta.py", line 295, in _get_build_requires
          self.run_setup()
        File "C:\Users\neph\AppData\Local\Temp\pip-build-env-1tdzldxr\overlay\Lib\site-packages\setuptools\build_meta.py", line 311, in run_setup
          exec(code, locals())
        File "<string>", line 246, in <module>
      OSError: [WinError 1314] Dem Client fehlt ein erforderliches Recht: '..\\examples' -> 'fairseq\\examples'
      [end of output]

  note: This error originates from a subprocess, and is likely not a problem with pip.
error: subprocess-exited-with-error

× Getting requirements to build wheel did not run successfully.
│ exit code: 1
╰─> See above for output.

note: This error originates from a subprocess, and is likely not a problem with pip.

sh1zooo · 2024-06-10T03:25:02Z

This is my first answer on any forum, besides, my English is bad. Sorry, guys.
Somehow it worked.

Run cmd as administrator(!) - (Running cmd as an administrator fixes the error [WinError 1314])
Write this to the console:

git clone https://github.com/pytorch/fairseq
cd fairseq
pip install --editable ./

Next, you may encounter the error "1 required argument is missing, containing only the keyword: 'recursive_guard'". You will need to change the Python version to 3.12.3 or lower. In version 3.12.4, this error will be displayed

JackismyShephard · 2024-07-08T00:41:29Z

I have encountered these problems, and here is my solution: Windows11 environment
pip install git+https://github.com/liyaodev/fairseq.git
or, download fairseq-0.12.3.1-cp311-cp311-linux_x86_64.whl
pip install./fairseq-0.12.3.1-cp311-cp311-linux_x86_64.whl
WSL2(Ubuntu22.04) environment(my local use)
pip install git+https://github.com/liyaodev/fairseq.git
or, download fairseq-0.12.3.1-cp311-cp311-linux_x86_64.whl
pip install./fairseq-0.12.3.1-cp311-cp311-linux_x86_64.whl
there's a little tip, best use hydra-core==1.3.2 omegaconf==2.3.0
does this still work?

This does not work for me on Windows 11. I am getting OSError: [WinError 126] The specified module could not be found. Error loading "C:\Users\Jacki\AppData\Local\Temp\pip-build-env-x3uaf2ep\overlay\Lib\site-packages\torch\lib\shm

Geremia · 2024-07-16T23:26:02Z

@yjyuanjin Your patch didn't work for me.
I'm using Python 3.11 on Linux.

FruitPigFoot · 2024-08-01T02:17:19Z

The official fix is too slow, I made a fix version myself. You can install it using the following command. v0.12.3. I conducted a simple test and found no abnormalities.
pip install git+https://github.com/One-sixth/fairseq.git

I'm on Ubuntu linux python 3.11.9(conda venv) and pip installing it worked

zxpoqas123 · 2024-08-06T06:17:36Z

I have encountered these problems, and here is my solution: Windows11 environment
pip install git+https://github.com/liyaodev/fairseq.git
or, download fairseq-0.12.3.1-cp311-cp311-linux_x86_64.whl
pip install./fairseq-0.12.3.1-cp311-cp311-linux_x86_64.whl
WSL2(Ubuntu22.04) environment(my local use)
pip install git+https://github.com/liyaodev/fairseq.git
or, download fairseq-0.12.3.1-cp311-cp311-linux_x86_64.whl
pip install./fairseq-0.12.3.1-cp311-cp311-linux_x86_64.whl
there's a little tip, best use hydra-core==1.3.2 omegaconf==2.3.0

python 3.11, problem solved! Many thanks.

zh-zhang1984 · 2024-08-17T01:20:46Z

field(default_factory=CommonConfig)

When I use this, the problem solved but there comes up with anther issue:
train.py: error: unrecognized arguments: --warmup-ratio= 0.01

usaraj added bug needs triage labels Mar 7, 2023

Birch-san mentioned this issue Apr 2, 2023

ValueError error when importing the pip package lucidrains/musiclm-pytorch#40

Closed

Medoalmasry added a commit to Medoalmasry/fairseq that referenced this issue Apr 7, 2023

support Python3.11 (facebookresearch#5012)

dac3615

Medoalmasry mentioned this issue Apr 7, 2023

Python 3.11 integration #5062

Open

4 tasks

MichaelMai2000 mentioned this issue May 23, 2023

hypo.word file missing during MMS ASR inference #5117

Open

PranjalChitale mentioned this issue Jul 6, 2023

spm_encode not found AI4Bharat/IndicTrans2#10

Closed

ivanstepanovftw mentioned this issue Jul 31, 2023

ValueError: common is not allowed lucidrains/naturalspeech2-pytorch#22

Closed

majiayu000 linked a pull request Oct 25, 2023 that will close this issue

Add support for Python3.11 #5359

Open

EmiliaTheGoddess mentioned this issue Oct 25, 2023

[Knowledge] ROCm (AMD GPU) Support on Linux Guide w-okada/voice-changer#868

Open

ciaotesla mentioned this issue Mar 5, 2024

Issue running on RPI, fairseq Vali-98/XTTS-RVC-UI#6

Closed

Phlayne mentioned this issue Mar 27, 2024

ValueError: mutable default <class 'fairseq.dataclass.configs.CommonConfig'> for field common is not allowed: use default_factory daswer123/rvc-python#4

Open

erew123 mentioned this issue May 21, 2024

Integration with RVC erew123/alltalk_tts#229

Closed

ZeaMays14142 mentioned this issue May 22, 2024

GPU usage going from python 3.10 > 3.11 stuck 100% cpu usage RVC-Project/Retrieval-based-Voice-Conversion-WebUI#2059

Closed

chanjuping mentioned this issue Jun 12, 2024

Fixes Dataclass error issue chanjuping/fairseq#1

Merged

hongjiang11 mentioned this issue Jun 20, 2024

The command '/bin/sh -c groupadd --gid $GID user' returned a non-zero code: 4 JarodMica/ai-voice-cloning#119

Open

abgulati mentioned this issue Jul 6, 2024

Kosmos-2.5 - Deployment Challenges on a Windows 11 + RTX 3090 PC microsoft/unilm#1596

Closed

MisileLab mentioned this issue Aug 28, 2024

support python 3.12 (and bump dependencies) daswer123/rvc-python#16

Open

pplantinga mentioned this issue Dec 11, 2024

Move files with optional dependencies to integrations folder speechbrain/speechbrain#2782

Draft

16 tasks

Dataclass error while importing Fairseq in Python 3.11 #5012

Dataclass error while importing Fairseq in Python 3.11 #5012

Comments

usaraj commented Mar 7, 2023

🐛 Bug

To Reproduce

Code sample

Environment

Additional context

VarunGumma commented Mar 13, 2023

EmreOzkose commented Mar 22, 2023

EmreOzkose commented Mar 22, 2023

VarunGumma commented Mar 22, 2023

Birch-san commented Apr 2, 2023

conan1024hao commented Apr 7, 2023

ashesfall commented Apr 9, 2023

Muskan19577 commented May 1, 2023 • edited Loading

ashesfall commented May 1, 2023

thyripian commented Jun 5, 2023

bit-scientist commented Aug 9, 2023

One-sixth commented Aug 11, 2023

kabyanil commented Sep 26, 2023

zhiqu22 commented Oct 5, 2023

MrGutarLed commented Oct 8, 2023

JingThree3 commented Oct 18, 2023

aikow commented Oct 18, 2023 • edited Loading

Y-H-Joe commented Nov 24, 2023 • edited Loading

CircuitCM commented Dec 15, 2023

liyaodev commented Jan 10, 2024 • edited Loading

Fmstrat commented Apr 13, 2024

yjyuanjin commented Apr 15, 2024 • edited Loading

last-fisherman commented Apr 15, 2024

liyaodev commented Apr 16, 2024

snoop2head commented Apr 26, 2024

tavyscrolls commented May 4, 2024

ZeaMays14142 commented May 22, 2024

ZeaMays14142 commented May 22, 2024

neph-64 commented May 25, 2024

sh1zooo commented Jun 10, 2024 • edited Loading

JackismyShephard commented Jul 8, 2024 • edited Loading

Geremia commented Jul 16, 2024 • edited Loading

FruitPigFoot commented Aug 1, 2024

zxpoqas123 commented Aug 6, 2024

zh-zhang1984 commented Aug 17, 2024

Muskan19577 commented May 1, 2023 •

edited

Loading

aikow commented Oct 18, 2023 •

edited

Loading

Y-H-Joe commented Nov 24, 2023 •

edited

Loading

liyaodev commented Jan 10, 2024 •

edited

Loading

yjyuanjin commented Apr 15, 2024 •

edited

Loading

sh1zooo commented Jun 10, 2024 •

edited

Loading

JackismyShephard commented Jul 8, 2024 •

edited

Loading

Geremia commented Jul 16, 2024 •

edited

Loading